API Reference

Create a new identity verification session

post
https://api.bynn.com/v1/sessions

Creates a new identity verification session using the provided applicant information. Returns the session token, URL, and optionally a QR code image as a base64 encoded PNG.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Applicant first name, (not required but highly recommended)

string

Applicant last name, (not required but highly recommended)

string

Unique identifier for the applicant in your system so you can identify the applicant in a webhook callback. Can be email or uuid., (not required but highly recommended)

string

Applicant phone number, (not required but highly recommended)

string

Applicant email address, (not required but highly recommended)

string
required

KYC level token Identifier (see: https://dashboard.bynn.com/setting/product/kyc)

boolean

Flag indicating if a QR code should be generated

string

Locale for the applicant ("en" for English)

Responses

Updated 12 months ago

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

Updated 12 months ago