POST
Submit KYC

Authorizations

app-id
string
header
required

A unique identifier assigned to each application.

secret-key
string
header
required

A secure token associated with the app-id.

Body

multipart/form-data
email
string
required

The contact's email used for verification.

document_type
enum<string>
required

The type of identification document (e.g., passport, id_card).

Available options:
passport,
id_card,
driving_license
document_number
string
required

The identification number on the document.

document_username
string
required

The name as shown on the identification document.

expiry_date
string
required

The expiry date of the identification document in format 'yyyy-mm-dd'.

issue_country
string
required

The country that issued the identification document (ISO 3166-1 alpha-2).

nationality
string
required

The country of nationality of the contact (ISO 3166-1 alpha-2 code).

selfie
file
required

A selfie image of the contact for identity verification should be in JPEG format.

id_doc_front_side
file
required

The front side image of the identification document should be in JPEG or PNG format.

id_doc_back_side
file
required

The back side image of the identification document should be in JPEG or PNG format.

webhook_notification
object
required

Merchant Callback Details

issue_date
string

The issue date of the identification document in format 'yyyy-mm-dd'.

Callbacks

POST
{$request.body#/endpoint_url}KYCStatusChanged

Body

application/json
email
string

Contact's email

first_name
string

Contact's first name

last_name
string

Contact's last name

type
enum<string>

The type of contact (e.g., individual or organization)

Available options:
individual,
organization
Example:

"individual"

dob
string

Contact date of birth format 'yyyy-mm-dd'

phone
string

Contact's phone

Example:

"+61-412345678"

reg_no
string

Contact registration number.

gender
enum<string>

Contact's gender

Available options:
male,
female
Example:

"male"

street
string

The primary name of an address's street.

city
string

Name of an address's city or town.

postal_code
string

The address's postcode

state
string

The address's state / province / county.

country
string

ISO 3166-1 alpha-2 country code.

identity
object

Contains the most recent KYC submission details for the contact.

kyc_statuses
object[]

An array of KYC statuses for the contact, containing multiple KYC instances with status and message.

Response

200

The merchant's server should return this code

Response

KYC submission successful

status
string