Verify Entity (AML)

This endpoint allows you to run a comprehensive AML check on an entity, this can either be a business or an individual.

POST {{baseurl}}/v2/api/entities/:entityId/amlChecks

Headers

Name	Type	Description
token*	String	API secret token

Parameter

Field	Type	Description
entityId*	String	Id of the entity being checked.

Request Body

Field	Type	Description
entityType*	String	Type of entity being checked. Allowed values: "individual", "business"
isSubjectConsent*	Boolean	Consent of the individual or business being checked. Allowed values: true
incorporationNumber	String	Business registration number(Required if amlCheckType is "id_number").
incorporationName	String	Registered name of the business.
incorporationCountry	String	Country code of business incorporation (ISO 3166-1 alpha-2). Size range: 2
incorporationDate	String	Date the business was incorporated. Size range: YYYY-MM-DD
amlCheckType	String	Type of AML check to perform. Allowed values: "name", "id_number"
amlChecks	String[]	Additional AML checks to perform.
ubos	Object	Information about Ultimate Beneficial Owners.
uboList	Object[]	List of UBOs.
category	String	UBO type. Allowed values: "individual", "business"
firstName	String	Required if UBO is individual.
lastName	String	Required if UBO is individual.
incorporationName	String	Required if UBO is business.
amlChecks	String[]	AML checks to perform on UBOs.
firstName	String	Required if AML checks are present.
lastName	String	Required if AML checks are present.
dateOfBirth	String	Required if AML checks are present. Size range: YYYY-MM-DD
nationality	String	Required if AML checks are present. Size range: 2

Verify Entity Sample Request (Individual)

{
    "entityType": "individual",
    "isSubjectConsent": true,
    "firstName": "John",
    "lastName": "Doe",
    "email": "[e-mail]",
    "phone": "[phone]",
    "gender": "male",
    "dateOfBirth": "1990-01-01",
    "nationality": "NG",
    "imageUrl": "http://someimage",
    "verifiedBy": "client"
}

Verify Entity Sample Request (Business)

{
    "entityType": "business",
    "isSubjectConsent": true,
    "incorporationName": "Acme Corp",
    "incorporationCountry": "NG",
    "incorporationDate": "2010-01-01",
    "amlCheckType": "name",
    "amlChecks": [
        "pep"
    ],
    "ubos": {
        "uboList": [
            {
                "category": "individual",
                "firstName": "Jon",
                "lastName": "Snow"
            }
        ],
        "amlChecks": [
            "pep"
        ]
    }
}

Success Response (Individual)

{
  "success": true,
  "status_code": 200,
  "message": "AML checks performed successfully!",
  "data": {
    "id": "ent_68343d1a83ab5c053a92511b",
    "entityType": "individual",
    "amlProcessedChecks": {
      "pep": {
        "status": "review_required",
        "reportId": "683505009fa4544ed0a350c3",
        "data": []
      }
    }
  },
  "links": []
}

Success Response (Business)

{
  "success": true,
  "status_code": 200,
  "message": "AML checks performed successfully!",
  "data": {
    "id": "ent_6834f77bc55aea948b907391",
    "entityType": "business",
    "amlProcessedChecks": {
      "sanctions": {
        "status": "not_cleared",
        "reportId": "68364960534488d5449f0784",
        "data": []
      }
    },
    "uboChecks": [
      {
        "ubo": "Jon Snow",
        "pep": {
          "status": "cleared",
          "reportId": "68364962534488d5449f0787",
          "data": []
        }
      }
    ]
  },
  "links": []
}

Error Response

HTTP/1.1 404 NotFound
{
  "success": false,
  "statusCode": 404,
  "message": "You have attempted to get a resource that does not exist.",
  "name": "ResourceNotFoundError",
  "data": {}
}