This endpoint verifies phone, email, address, date of birth and tax numbers, specifically social security number (ssn). When making a request use "kyc" in the plugins array. To have the API return specific risk scores for phone, email, ssn (taxId) and address, see examples below.
API reference, eKYC
External Verification (eKYC)
POST
https://demo-api.incodesmile.com/omni/externalVerification/ekycHeaders
Request body
application/json
enum
kycThe following special characters are not supported: `^±!@£$%&*_+¡€#¢§¶•ªº«<>?\\/:;\
The following special characters are not supported: `^±!@£$%&*_+¡€#¢§¶•ªº«<>?\\/:;\
The following special characters are not supported: `^±!@£$%&*_+¡€#¢§¶•ªº«<>?\\/:;\
The following special characters are not supported: `^±!@£$%&*_+¡€#¢§¶•ªº«<>?\\/:;\
ISO 3166-1 alpha-2 format
Use E.164 format. Hyphens are optional
Indian Permanent Account Number (PAN), format: AAAAANNNNA
District or Barangay (neighbourhood), used for Philippines KYC
National ID type. Supported for Philippines KYC: SSS, TIN, GSIS
ID document issue date. Required for Colombia Civil Register (CO_CIVIL_REGISTER_1) KYC
Responses
Response body (application/json)
Indicates a type of risk, such as addressRiskLevel. The overallLevel key name is an aggregate risk score for all risk types. It can be used to obtain a single risk score for a whole result set.
Explains the risk level, ie "low", "medium", or "high". When doing a social security number check, the API will return status values of nomatch, fuzzy or exact. Fuzzy means there is plausible match between the name and the social security number, like Dave and David both resolve to the same SSN.
Additional info on the status.
Indicates a type of risk, such as addressRiskLevel. The overallLevel key name is an aggregate risk score for all risk types. It can be used to obtain a single risk score for a whole result set.
Explains the risk level, ie "low", "medium", or "high". When doing a social security number check, the API will return status values of nomatch, fuzzy or exact. Fuzzy means there is plausible match between the name and the social security number, like Dave and David both resolve to the same SSN.
Additional info on the status.
Response body (application/json)
UTC timestamp in milliseconds
Custom error code or HTTP status code
HTTP status error
Custom error message
Endpoint path
Custom error details