Getting started

Here you'll find quick steps to get you started.

1. Get an API key

We use API keys to authenticate requests. You can get API key in Dashboard > API.

After you created API key you can insert it in the Authorization header to send requests to endpoints.

2. Make a test request

Ask for verified claims from Passport. For example given_name, family_name and nationality as in below. For list of claims available, see request endpoint reference.

cURL

curl --request POST \
     --url https://api.yumipass.com/checkid/v1/requests \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-yumipass-api-key: <YOUR API KEY>' \
     --data '
{
  "claims": [
    "given_name",
    "family_name",
    "nationality"
  ]
}
'

The response will look like:

JSON

{ 
    code: 1,
    message: 'request successfully initiated',
    timestamp: '2025-03-12T18:53:34Z',
    sessionId: '45FtdWxfIHNwebHRhbmVuIE0gMTQwNjEwOTYgZmlubGBAF',
    qrcode: 'iVBORw0KGgoAAAANSUhEUgAAAMgAAADIAQAAAACFI5MzAAABGUlEQVR42u2YSw7DIAxEzYpjcFM'
} 

Grab the qrcode and paste it into for example base64-to-image-converter . and scan the displayed qrcode image with your mobile. You will be prompted to install yumipass NFC scanning app.

Once you've NFC scanned your document, replace sessionId with the real value from the request:

cURL

curl --request POST \
     --url https://api.yumipass.com/checkid/v1/reply \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-yumipass-api-key: <YOUR API KEY>' \
     --data '
{
  "sessionId": '45FtdWxfIHNwebHRhbmVuIE0gMTQwNjEwOTYgZmlubGBAF'
}
'

And your response will look like:

JSON

{ 
    given_name: 'John Abraham',
    family_name: 'Lincoln',
    nationality: 'USA',
} 

Returned claims are guaranteed to have arrived from 100% authentic and live Passport.