Create a dossier

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 requested type.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Create a dossier

string
enum
Defaults to kyc

Dossier product: kyc (individual) or kyb (company).

Allowed:
string

Verification level identifier (humanized token) of the matching type. Defaults to your first level of that type when omitted.

string

Applicant first name (individual). Highly recommended.

string

Applicant last name (individual). Highly recommended.

string

Company name (used as the dossier/subject name for kyb).

string

Your identifier for this applicant (stored as the dossier reference / customer_identification).

string

Applicant phone number (E.164). Required to send an SMS invite.

string

Applicant email address. Required to send an email invite.

string

Locale for the applicant / invite (e.g. "en").

boolean

Return a base64 PNG QR code of the verification URL.

boolean

Send the verification link to the applicant by SMS (requires phone_number).

boolean

Send the verification link to the applicant by email (requires email_address).

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json