This endpoint performs an eKYC income check
API reference, eKYC
eKYC Income verification
POST
https://demo-api.incodesmile.com/omni/externalVerification/incomeHeaders
Request body
application/json
11 digit CPF
Two letter Alpha-2 country code. (Must be BR).
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.
enum
phoneCheckadvancedPhoneCheckemailCheckphoneProfileOutcome of the check for the provided phone number: found or notFound.
Explanation returned when checkStatus is notFound.
Confidence in the returned identity match: low, medium or high.
First name on file for the phone number.
Last name on file for the phone number.
Date of birth on file, yyyy-MM-dd. Availability varies by country.
Whether the provider considers the phone number valid.
Country of the phone number as reported by the provider.
Single concatenated address string, not split into street, city, state or postal code.
True only when both phoneFirstName and phoneLastName were returned.
Age computed from phoneDob at the time of the check. Absent when phoneDob is unavailable.
True when phonePersonAge is 18 or more, or, without a date of birth, when a name was returned.
First name of the alternate candidate identity.
Last name of the alternate candidate identity.
Date of birth of the alternate candidate identity, yyyy-MM-dd, when the provider returns it.
Single concatenated address string, not split into street, city, state or postal code.
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