NFC data submission

post

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

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

Body Params

session_id

string

Unique session token

can

string

Card Access Number (CAN) for PACE authentications.

authenticationStatus

object

required

Authentication status from NFC chip

cameraImage

string

Base64 strict encoded camera image of the document

faceImageBase64

string

required

Base64 strict encoded face image from NFC chip

certificateInfo

object

Document certificate information

dateOfBirth

string

required

Date of birth (YYMMDD format)

dateOfExpiry

string

required

Document expiry date (YYMMDD format)

documentNumber

string

required

Document number

gender

string

enum

required

Gender

Allowed:

givenNames

string

required

Given names from document

surname

string

required

Surname from document

nationality

string

required

Nationality code (3-letter)

issuer

string

required

Document issuing country code (3-letter)

personalNumber

string

Personal identification number

hashVerification

object

required

Hash verification data

locationData

object

Location data

mrzData

string

Complete MRZ data as multi-line string

rawDG1

string

required

Data Group 1 - MRZ information

rawDG2

string

required

Data Group 2 - Encoded face image (Biometrics)

rawDG3

string

Data Group 3 - Fingerprint data (Biometrics)

rawDG4

string

Data Group 4 - Iris data (Biometrics)

rawDG5

string

Data Group 5 - Displayed portrait

rawDG6

string

Data Group 6 - Reserved for future use

rawDG7

string

Data Group 7 - Displayed signature

rawDG8

string

Data Group 8 - Data features

rawDG9

string

Data Group 9 - Structure features

rawDG10

string

Data Group 10 - Substance features

rawDG11

string

Data Group 11 - Additional personal details

rawDG12

string

Data Group 12 - Additional document details

rawDG13

string

Data Group 13 - Optional details

rawDG14

string

required

Data Group 14 - Security infos

rawDG15

string

required

Data Group 15 - Active authentication public key

rawDG16

string

Data Group 16 - Persons to notify

rawSOD

string

required

SOD - Security Object Data

Responses

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201NFC data submission

400Invalid NFC data

404Invalid session

422NFC data validation failed