--- updatedAt: 2025-11-11T00:09:52.000Z agentTools: projectIndex: https://docs.interswitchgroup.com/v1.1/llms.txt --- # Individual and Business Verification ## 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 | # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "ipg", "version": "1.1" }, "servers": [ { "url": "https://sandbox.interswitchng.com" } ], "components": { "securitySchemes": { "sec0": { "type": "oauth2", "flows": {} } } }, "security": [ { "sec0": [] } ], "paths": { "//": { "post": { "summary": "Individual and Business Verification", "description": "", "operationId": "individual-and-corporate-verification", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "verificationRequests", "callbackUrl" ], "properties": { "type": { "type": "string", "description": "The type of the entity. Value must be one of 'INDIVIDUAL' or 'CORPORATE' for individual and business verifications respectively." }, "email": { "type": "string", "description": "The email address of the entity. This is optional for INDIVIDUAL verification but required for BUSINESS verification" }, "phone": { "type": "string", "description": "The phone number of the entity. This is required for INDIVIDUAL verification but optional for BUSINESS." }, "lastName": { "type": "string", "description": "The last name of the individual entity. This is required for INDIVIDUAL verification but not applicable to BUSINESS verification." }, "firstName": { "type": "string", "description": "The first name of the individual entity. This is required for INDIVIDUAL verification but not applicable to BUSINESS verification." }, "middleName": { "type": "string", "description": "The middle name of the individual entity. This is optional for INDIVIDUAL verification but not applicable to BUSINESS verification." }, "birthDate": { "type": "string", "description": "The date of birth of an individual entity. This is required for INDIVIDUAL verification but not applicable to BUSINESS verification. Format must be yyyy-MM-dd" }, "gender": { "type": "string", "description": "The gender of an individual entity. This is required for INDIVIDUAL verification if AML is to be processes. It is not applicable to BUSINESS verification. Expected value is MALE or FEMALE." }, "registeredName": { "type": "string", "description": "The name of the corporate entity. This is not applicable to INDIVIDUAL verification but required for BUSINESS." }, "verificationRequests": { "type": "object", "description": "List of verification requests to be processed for the entity", "required": [ "type" ], "properties": { "type": { "type": "string", "description": "The type of the verification. For INDIVIDUAL verification, the expected fields are ADDRESS, AML, BVN, DRIVERS_LICENSE, NIN and PASSPORT. For CORPORATE, the expected fields are ADDRESS, AML and CORPORATE_REGISTRATION" }, "lastName": { "type": "string", "description": "The last name of the individual entity tied to the verification. It is required if it is different from the entity request last name." }, "identityNumber": { "type": "string", "description": "The identification number of the verification type. This is required for the fields BVN, CORPORATE_REGISTRATION, DRIVERS_LICENSE, NIN and PASSPORT. BVN and NIN must be 11 digits." }, "phone": { "type": "string", "description": "The phone number of the entity tied to the verification. It is required if it is different from the entity request phone number." }, "country": { "type": "string", "description": "ADDRESS - Country of the address AML(CORPORATE) - Country of registration of the corporate AML(INDIVIDUAL) - Country of residence of the individual DRIVERS_LICENCE - Issuing country PASSPORT - Issuing country BANK_ACCOUNT - Country where account was created" }, "buildingNumber": { "type": "string", "description": "The building number of the address. This is only applicable to the ADDRESS FIELD" }, "street": { "type": "string", "description": "The street number of the address. This is only applicable to the ADDRESS FIELD" }, "landmark": { "type": "string", "description": "The landmark near the address. This is only applicable to the ADDRESS FIELD" }, "city": { "type": "string", "description": "The city of the address. This is only applicable to the ADDRESS FIELD" }, "state": { "type": "string", "description": "The state of the address. This is only applicable to the ADDRESS FIELD. It must be a valid ISO sub-division code for the country. Format: CC-XYZ where CC is ISO Alpha-2 code and XYZ is sub-division code of 1 to 3 characters. Min: 4 characters. Max: 6 characters" }, "base64EncodedImage": { "type": "string", "description": "Applicable to INDIVIDUAL verification. The base64 encoded image of the individual. Required for address verification of an individual" }, "birthCountry": { "type": "string", "description": "Applicable to INDIVIDUAL verification. The birth country of the individual entity. This is optional for AML verification. Must be a valid ISO Alpha-3 code" }, "nationality": { "type": "string", "description": "Applicable to INDIVIDUAL verification. This is the nationality of the individual. Must be a valid ISO Alpha-3 code" }, "reprocess": { "type": "string", "description": "Boolean flag to indicate that a verification must be processed afresh i.e. an existing verification should not be used" }, "documents": { "type": "object", "description": "List of verification documents for the verification", "properties": {} }, "accountNumber": { "type": "string", "description": "The account number of the entity to be verified. Required for the BANK_ACCOUNT field" }, "bankCode": { "type": "string", "description": "The CBN bank code of the bank of the account number. This is required for the BANK_ACCOUNT field." } } }, "callbackUrl": { "type": "string", "description": "The url where case updates would be sent." } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{} " } }, "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```