API Reference

NFC data submission

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

Submit NFC-scanned identity document data from mobile device NFC reader to the session.

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

NFC data submission

string

Unique session token

string

Card Access Number (CAN) for PACE authentications.

authenticationStatus
object
required

Authentication status from NFC chip

string

Base64 strict encoded camera image of the document

string
required

Base64 strict encoded face image from NFC chip

certificateInfo
object

Document certificate information

string
required

Date of birth (YYMMDD format)

string
required

Document expiry date (YYMMDD format)

string
required

Document number

string
enum
required

Gender

Allowed:
string
required

Given names from document

string
required

Surname from document

string
required

Nationality code (3-letter)

string
required

Document issuing country code (3-letter)

string

Personal identification number

hashVerification
object
required

Hash verification data

locationData
object

Location data

string

Complete MRZ data as multi-line string

string
required

Data Group 1 - MRZ information

string
required

Data Group 2 - Encoded face image (Biometrics)

string

Data Group 3 - Fingerprint data (Biometrics)

string

Data Group 4 - Iris data (Biometrics)

string

Data Group 5 - Displayed portrait

string

Data Group 6 - Reserved for future use

string

Data Group 7 - Displayed signature

string

Data Group 8 - Data features

string

Data Group 9 - Structure features

string

Data Group 10 - Substance features

string

Data Group 11 - Additional personal details

string

Data Group 12 - Additional document details

string

Data Group 13 - Optional details

string
required

Data Group 14 - Security infos

string
required

Data Group 15 - Active authentication public key

string

Data Group 16 - Persons to notify

string
required

SOD - Security Object Data

Responses

Updated about 1 month ago

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

Updated about 1 month ago