post https://sandbox.interswitchng.com//
Response Description
| Field | Description | Availability |
|---|---|---|
| type | The type of the verification | always |
| status | The status of the request processing - PENDING, VERIFIED, NOT VERIFIED, MATCH, NO MATCH, FAILED | always |
| identityNumber | The identification number of the verification | if status is not FAILED and type is one of BVN, CORPORATE_REGISTRATION, DRIVERS_LICENCE, NIN, PASSPORT |
| lastName | The last name tied to the verification | if status is not FAILED and type is one of ADDRESS, BVN, DRIVERS_LICENCE, NIN, PASSPORT, BANK_ACCOUNT |
| firstName | The first name tied to the verification | if status is not FAILED and type is one of ADDRESS, BVN, DRIVERS_LICENCE, NIN, PASSPORT., BANK_ACCOUNT |
| birthDate | The birth date tied to the verification | if status is not FAILED and type is one of ADDRESS, BVN, DRIVERS_LICENCE, NIN, PASSPORT |
| phone | The phone number tied to the verification | if status is not FAILED and type is one of ADDRESS, PASSPORT, BANK_ACCOUNT |
| country | The country tied to the verification | if status is not FAILED and type is one of ADDRESS, CORPORATE_REGISTRATION, DRIVERS_LICENCE, PASSPORT, BANK_ACCOUNT |
| bvn | The bvn of the account | if status is not FAILED and type is BANK_ACCOUNT |
| accountName | The verified account name | if status is not FAILED and type is BANK_ACCOUNT |
| accountNumber | The account number in the request | if status is not FAILED and type is BANK_ACCOUNT |
| buildingNumber | The building number of the address | if status is not FAILED and type is ADDRESS |
| street | The street name of the address | if status is not FAILED and type is ADDRESS |
| landmark | A landmark near the address | if status is not FAILED and type is ADDRESS |
| city | The state of the address | if status is not FAILED and type is ADDRESS |
| state | The state of the address | if status is not FAILED and type is ADDRESS |
| authority | The issuing authority of the verification | if status is VERIFIED and type is PASSPORT |
| issueDate | The issue date of the verification | if status is VERIFIED and type is PASSPORT |
| expiryDate | The expiry date of the verification | if status is VERIFIED and type is PASSPORT |
| corporateType | The type of the corporate | if status is VERIFIED and type is CORPORATE_REGISTRATION |
| incorporationDate | The incorporation date of the corporate | if status is VERIFIED and type is CORPORATE_REGISTRATION |
| shareCapital | The share capital of the corporate | if status is VERIFIED and type is CORPORATE_REGISTRATION |
| stakeholders | List of stakeholders | if status is VERIFIED and type is CORPORATE_REGISTRATION |
| kycDomain | The domain of the AML case for the entity | if status is not FAILED and type is AML |
| amlMatches | List of AML case matches for the entity | if status is MATCH and type is AML |
| reference | The system reference for the verification request | always |
| failureCode | The code of the failure | if status is FAILED |
| failureDescription | The description of the failure | if status is FAILED |
| errors | The request object field errors | if status is FAILED and the failure is due to request object fields - syntax errors, data type mismatches, validation errors |
POSSIBLE VALUES FOR THE 'stakeholders' FIELD IN THE RESPONSE
| Field | Description | Availability |
|---|---|---|
| firstName | The first name of the stakeholder | if entityType is INDIVIDUAL |
| lastName | The last name of the stakeholder | if entityType is INDIVIDUAL |
| middleName | The middle name of the stakeholder | if entityType is INDIVIDUAL |
| name | The name of the stakeholder | if entityType is CORPORATE |
| type | The type of the stakeholder - DIRECTOR, PROPRIETOR, SECRETARY, SHAREHOLDER, TRUSTEE | always |
| entityType | The entity type of the stakeholder - CORPORATE, INDIVIDUAL | always |
| numberOfShares | The number of shares owned by the stakeholder | if type is SHAREHOLDER |
POSSIBLE VALUES FOR THE 'amlMatch' FIELD IN THE RESPONSE
| Field | Description | Availability |
|---|---|---|
| categories | List of categories of the matched entity from the matching source | always |
| status | Resolution status provided by the resolution officer POSITIVE, POSSIBLE, FALSE, UNSPECIFIED | if match has been resolved by a resolution officer |
| reason | Resolution reason provided by the resolution officer FULL MATCH, PARTIAL MATCH, NO MATCH, UNKNOWN | if match has been resolved by a resolution officer POSITIVE - FULL MATCH POSSIBLE - PARTIAL MATCH FALSE - NO MATCH UNSPECIFIED - UNKNOWN |
| risk | Risk level attributed to this match by the resolution officer HIGH, MEDIUM, LOW, UNKNOWN | if match has been resolved and a risk level was provided by a resolution officer POSITIVE - HIGH, MEDIUM, LOW POSSIBLE - HIGH, MEDIUM, LOW, UNKNOWN FALSE - UNKNOWN UNSPECIFIED - UNKNOWN |
| remark | Resolution remark provided by the resolution officer | if match has been resolved and a remark was provided by a resolution officer |