Creates a new KYC or KYB dossier (a verification case) under one of your
verification levels, provisions the applicant and a hosted verification
session, and returns the dossier token together with the verification URL
(and, optionally, a QR code).
Choose the product with the type parameter (kyc or kyb). The level you
reference must belong to the same product family.
Sending the invite
Set send_sms and/or send_email (with a phone_number / email_address) to
have Bynn deliver the verification link to the applicant for you. Otherwise the
returned verification_url (and optional qr_base64_png) is yours to deliver.
Retrieving results later
After the applicant completes the session (see the session.completed webhook,
which returns this dossier_id), call GET /dossiers/:id to fetch the full
result including the liveness selfie and ID-document images.
Errors
401 authentication_error— missing, malformed, or revoked private key.402 payment_required— the request could not be completed for this account.404 validation_error— no matching level for the requestedtype.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||