Skip to main content
POST
Start an eID check

Authorizations

Authorization
string
header
required

API key created in the console. Scopes: kyc:extract, kyc:verify, kyc:eid; bank:read, bank:write (Growth plan, enabled per workspace by Sahl).

Body

application/json
reference
string
required

Your own id for the client, 1 to 64 characters of A-Z a-z 0-9 _ . : -.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9_.:-]+$
first_name
string
required
Required string length: 1 - 100
last_name
string
required
Required string length: 1 - 100
email
string<email>
required

The provider emails the client a PIN and a link to this address as soon as the request is created.

country
string
required

Country of the client. Only Canada is accepted: CA or CAN.

Required string length: 2 - 3
language
enum<string>
default:en

Language of the client's email and screens: en or fr.

Available options:
en,
fr
documents
enum<integer>
default:1

How many pieces of ID the client must scan: 1 or 2.

Available options:
1,
2
environment
enum<string>
default:sandbox

Picks the case the request is filed on. It does not stop the provider from emailing the client.

Available options:
sandbox,
production

Response

Created. The client has been emailed.

key
integer
required

Id of the eID request. Use it to poll.

reference
string
required