API Reference

User linking

User linking is required to initiate the identity request with a Push notification instead of a qrcode.

User linking is a simple mapping between a user mobile and a given user ID in your app. Its not a link between a specific Passport and a user ID.

To enable user linking, add attribute persistentID (userIdentificationCookie in v1) with value of your choice to the request.

For example:

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" ],
     "persistentID": "[email protected]"	
}
'

After this, subsequent identity requests with [email protected] can be done with a Push notification instead of qrcode:

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" ],
	"persistentID": "[email protected]",	
	"push": true
}
'