External Verification (eKYC)

post https://demo-api.incodesmile.com/omni/externalVerification/ekyc

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.

Body Params

Note: When fields are provided they will override field values derived from a document scan.

Examples

Check address:

{
    "plugins": ["kyc"],
    "firstName": "Jon",
    "surName": "Hasselhoff",
    "street": "101 Beach Highway",
    "postalCode": "90210",
    "state": "CA",
    "city": "Beverly Hills",
    "countryCode": "US"
}

Check email:

{
    "plugins": ["kyc"],
    "firstName": "Jon",
    "surName": "Hasselhoff",
    "email": "david.hasselhoff@email.com"
}

Check phone:

{
    "plugins": ["kyc"],
    "firstName": "Jon",
    "surName": "Hasselhoff",
    "phone": "+16504463444"
    "street": "101 Beach Highway",
    "postalCode": "90210",
    "state": "CA",
    "city": "Beverly Hills",
    "countryCode": "US"
}

Check SSN (taxId):

{
    "plugins": ["kyc"],
    "firstName": "Jon",
    "surName": "Hasselhoff",
    "street": "101 Beach Highway",
    "postalCode": "90210",
    "state": "CA",
    "city": "Beverly Hills",
    "countryCode": "US",
    "taxId": "123456789",
    "dateOfBirth": "1980-06-01"
}

Full eKYC check:

{
    "plugins": ["kyc"],
    "firstName": "Jon",
    "middleName": "Michael",
    "surName": "Hasselhoff",
    "street": "101 Beach Highway",
    "postalCode": "90210",
    "state": "CA",
    "city": "Beverly Hills",
    "countryCode": "US",
    "phone": "+16504463444",
    "email": "david.hasselhoff@email.com"
    "taxId": "123456789",
    "dateOfBirth": "1980-06-01"
}

plugins

array of strings

plugins

firstName

string

The following special characters are not supported: ^±!@£$%&*_+¡€#¢§¶•ªº«<>?\/:;|=

surName

string

The following special characters are not supported: ^±!@£$%&*_+¡€#¢§¶•ªº«<>?\/:;|=

middleName

string

The following special characters are not supported: ^±!@£$%&*_+¡€#¢§¶•ªº«<>?\/:;|=

maternalSurname

string

The following special characters are not supported: ^±!@£$%&*_+¡€#¢§¶•ªº«<>?\/:;|=

string

street

string

streetNo

string

floor

string

apartment

string

postalCode

string

countryCode

string

ISO 3166-1 alpha-2 format

phone

string

Use E.164 format. Hyphens are optional

state

string

city

string

idNumber

string

idNumber1

string

gender

string

taxId

string

dateOfBirth

string

dlExpireAt

string

Headers

api-version

string

required

Defaults to 1.0

Responses

Language

Credentials


xxxxxxxxxx
1
curl --request POST \
2
     --url https://demo-api.incodesmile.com/omni/externalVerification/ekyc \
3
     --header 'accept: application/json' \
4
     --header 'api-version: 1.0' \
5
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request