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 x-yumipass-api-key header to send requests to endpoints.

2. Start an identity request (v1/requests/)

Request verified claims from Passport. For example given_name, family_name and nationality as in below. Use callbackURL if you like to be notified of ready results.

For full list of claims that can be collected from a Passport, and optional request parameters, see requests 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" ],
	"callbackURL": "Optional URL to notify when Passport results are ready"
}
'

The response will look like:

JSON

{
  "code": 1,
  "message": "identity request initiated",
  "sessionId": "45FtdWxfIHNwebHRhbmVuIE0gMTQwNjEwOTYgZmlubGBAF",
  "qruri": "yumipass://checkid/D2C214840C986DB5C9CDBA5F1ED746B4"
  "qrcode": "iVBORw0KGgoAAAANSUhEUgAAAMgA.....AABGUlEQVR42u2YSw7DIAxEzYpjcFM",  
  "created": "2025-08-25 14:46:49Z",
  "expires": "2025-08-25 14:51:49Z",
  "timestamp": "2025-08-25 14:46:49Z",
  "notificationToken": "eyJ0eXAiOiJKV1QiLCJ......syh-bZQbcCA5ZW4VvsqXYGNqXg6w"
} 

Then:

1. Make a note of the sessionId
2. 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 "Passport NFC verification" app.

3. Collect verified identity claims (v1/reply/)

Once you've finished NFC scanning your Passport, collect the results with a call to reply endpoint using the sessionId : .

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 you will get a response like:

JSON

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

The response claims are guaranteed to have originated from 100% authentic and live Passport.