API Reference

Create a new request

post
https://api.yumipass.com/checkid/v2/requests

Initiates a new request to collect identity claims.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
claims
array of strings
required

JSON array of identity claims to retrieve.

claims*
string
length ≤ 255

Name displayed in the YumiPass app to identify the request source.

string
length ≤ 255

Cookie used by YumiPass to identify returning users.

boolean
Defaults to false

Whether to send a push notification to the user.

boolean
Defaults to true

Whether NFC scan of an identity document is enforced.

Headers
string
required

A valid YumiPass API key.

Response

Updated about 2 months ago

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

Updated about 2 months ago