API Reference

Getting Started

Set up the welcome page for your API to help users make their first call.

1Pick a language

2Credentials

Get API Key
Header

3Try It!

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)

LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Popular Endpoints
Last 24 Hours