Skip to main content
GET
Get 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).

Path Parameters

key
integer
required

The key returned by POST /v1/kyc/eid.

Query Parameters

environment
enum<string>
default:sandbox

Only places a request started before Sahl kept the eID record. A request made through POST /v1/kyc/eid keeps its own environment.

Available options:
sandbox,
production

Response

OK

key
integer
required
complete
boolean
required

True once the client has scanned a document.

passed
boolean
required

True when complete and no critical eID check failed.

identity
object
required

What the check proved. Possible keys: documentType, documentNumber, expiryDate, birthDate, firstName, lastName, address. Empty until complete.

checks
Check · object[]
required
completed_date
string | null
required