Jumio
App · 13 actions
Verify people's identity with Jumio: send a link to photograph an ID and take a selfie, read the decision and the details on the ID, report fraud, and delete personal data on request.
Actions
| Action | What it does |
|---|---|
| Create verification | Start an ID verification for someone new and get the link they open to photograph their ID and take a selfie. |
| Delete account biometrics | Permanently delete the biometric data (face scans) of every verification of one account, keeping their results. |
| Delete account data | Permanently delete the personal data of every verification of one account, such as for a GDPR erasure request. |
| Delete verification biometrics | Permanently delete only the biometric data (face scans) of one verification, keeping its results. |
| Delete verification data | Permanently delete the personal data of one verification: its images, the details read off the ID and its biometrics. |
| Get Jumio status | Check whether Jumio is working in your data center: its API, verification page, processing and callbacks. |
| Get verification results | Get a finished verification's decision and risk score, the details read off the ID (name, date of birth, document number), and how the document, liveness and selfie match checks went. |
| Get verification rules | List the risk rules a verification was scored by, and which of them matched. |
| Get verification status | Get where a verification is: not started yet, processed, or expired before the person finished. |
| Get verification steps | List the services a verification ran, each with its decision and the checks it made. |
| List recent verifications | List the most recently processed verifications, newest first, each with its account, decision and risk score. |
| Report fraud on verification | Tell Jumio whether a verification turned out to be fraud, which helps it tune your risk scoring. |
| Verify existing account again | Start another verification for someone Jumio already has an account for, such as a returning customer, and get a new link. |
Create verification
Start an ID verification for someone new and get the link they open to photograph their ID and take a selfie. Jumio makes an account for the person; keep its id to verify them again later.
Inputs
- Workflow
workflow_keytextRequired - What Jumio checks, such as ID and selfie. Use a key your Jumio account manager has turned on for you.
- Your reference
customer_internal_referencetextRequired - Your own reference for this verification, such as an application number. No names, emails or other personal details.
- Your ID for the person
user_referencetext - Your own id for the person being verified, such as a customer number. No personal details.
- Reporting label
reporting_criteriatext - A label to search and group verifications by in Jumio.
- Accepted ID types
id_typeslist - Only accept these kinds of ID. Leave empty for every kind.One or more of:
PASSPORT,DRIVING_LICENSE(Driver's license),ID_CARD(ID card),VISA,DIGITAL_IDENTITY(Digital identity). - Accepted ID countries
id_countrieslist - Only accept IDs issued by these countries. Leave empty for every country your Jumio account accepts.One or more of:
AFG(Afghanistan (AFG)),ALA(Åland Islands (ALA)),ALB(Albania (ALB)),DZA(Algeria (DZA)),ASM(American Samoa (ASM)),AND(Andorra (AND)),AGO(Angola (AGO)),AIA(Anguilla (AIA)),ATA(Antarctica (ATA)),ATG(Antigua and Barbuda (ATG)), and 242 more. - Link lasts (minutes)
link_lifetime_minutesnumber - How long the person has to start, from 5 minutes to 60 days. Jumio's default is 30 minutes.From 5 to 86400.
- Language
localetext - The language of the verification page. Defaults to your Jumio setting.One of:
en(English (US)),en-GB(English (UK)),sq(Albanian),ar(Arabic),az(Azerbaijani),bn(Bengali),bn-IN(Bengali (India)),bg(Bulgarian),my-MM(Burmese (Myanmar)),ca(Catalan), and 55 more. - Page after success
success_urltext - An https:// page to send the person to when they finish.
- Page after an error
error_urltext - An https:// page to send the person to if it fails.
- Callback URL
callback_urltext - An https:// address Jumio tells when this verification changes, in place of the one in your Jumio settings.
Outputs
account_idtext- The new verification's account; keep it for later steps
created_attext- When Jumio created it (ISO 8601, UTC)
credentialslist- What the person will be asked for
error_urltext- Where they go after an error, if set
success_urltext- Where they go after finishing, if set
verification_linktext- The link the person opens to photograph their ID and take a selfie
workflow_execution_idtext- The verification's id
Example output
{
"account_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2026-11-17T14:15:22Z",
"credentials": [
{
"allowedChannels": [
"WEB",
"SDK"
],
"category": "ID",
"country": {
"predefinedType": "DEFINED",
"values": [
"USA"
]
},
"id": "fdb1bc31-99a0-4671-8f2a-2bf7ca2faace",
"type": {
"predefinedType": "DEFINED",
"values": [
"DRIVING_LICENSE"
]
}
},
{
"allowedChannels": [
"WEB",
"SDK"
],
"category": "SELFIE",
"id": "bce8a24b-16ba-46a8-994e-fa76e4c4845b"
}
],
"error_url": "https://example.com/not-verified",
"success_url": "https://example.com/verified",
"verification_link": "https://acme.web.amer-1.jumio.ai/web/v4/app?authorizationToken=eyJhbGciOi&locale=en-US",
"workflow_execution_id": "41f71912-1c6b-4e2f-b340-d6dc10cd69b8"
}Delete account biometrics
Permanently delete the biometric data (face scans) of every verification of one account, keeping their results. This can't be undone.
Inputs
- Account
account_idtextRequired - The Jumio account (one per person verified). Pick a recent one, or give its id from an earlier step.
Outputs
account_idtext- The account
already_deletedtrue/false- True if Jumio had already wiped it
deletedtrue/false- True once Jumio has accepted it
Example output
{
"account_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"already_deleted": false,
"deleted": true
}Delete account data
Permanently delete the personal data of every verification of one account, such as for a GDPR erasure request. This can't be undone.
Inputs
- Account
account_idtextRequired - The Jumio account (one per person verified). Pick a recent one, or give its id from an earlier step.
Outputs
account_idtext- The account
already_deletedtrue/false- True if Jumio had already wiped it
deletedtrue/false- True once Jumio has accepted it
Example output
{
"account_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"already_deleted": false,
"deleted": true
}Delete verification biometrics
Permanently delete only the biometric data (face scans) of one verification, keeping its results. This can't be undone.
Inputs
- Account
account_idtextRequired - The Jumio account (one per person verified). Pick a recent one, or give its id from an earlier step.
- Verification
workflow_execution_idtextRequired - The verification (Jumio calls it a workflow execution). Pick a recent one, or give its id from an earlier step.
Outputs
account_idtext- The account
already_deletedtrue/false- True if Jumio had already wiped it
deletedtrue/false- True once Jumio has accepted it
workflow_execution_idtext- The verification
Example output
{
"account_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"already_deleted": false,
"deleted": true,
"workflow_execution_id": "41f71912-1c6b-4e2f-b340-d6dc10cd69b8"
}Delete verification data
Permanently delete the personal data of one verification: its images, the details read off the ID and its biometrics. This can't be undone.
Inputs
- Account
account_idtextRequired - The Jumio account (one per person verified). Pick a recent one, or give its id from an earlier step.
- Verification
workflow_execution_idtextRequired - The verification (Jumio calls it a workflow execution). Pick a recent one, or give its id from an earlier step.
Outputs
account_idtext- The account
already_deletedtrue/false- True if Jumio had already wiped it
deletedtrue/false- True once Jumio has accepted it
workflow_execution_idtext- The verification
Example output
{
"account_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"already_deleted": false,
"deleted": true,
"workflow_execution_id": "41f71912-1c6b-4e2f-b340-d6dc10cd69b8"
}Get Jumio status
Check whether Jumio is working in your data center: its API, verification page, processing and callbacks.
Inputs
None.
Outputs
detailsobject- What is not working, by part (api, web, processing...)
is_uptrue/false- True if all is working
statustext- UP, DEGRADED or DOWN
Example output
{
"details": {},
"is_up": true,
"status": "UP"
}Get verification results
Get a finished verification's decision and risk score, the details read off the ID (name, date of birth, document number), and how the document, liveness and selfie match checks went. Images are never included.
Inputs
- Account
account_idtextRequired - The Jumio account (one per person verified). Pick a recent one, or give its id from an earlier step.
- Verification
workflow_execution_idtextRequired - The verification (Jumio calls it a workflow execution). Pick a recent one, or give its id from an earlier step.
Outputs
account_idtext- The Jumio account (the person) the verification is for
checkslist- Every check run, with its decision
completed_attext- When it finished (ISO 8601, UTC), empty until then
created_attext- When it was created (ISO 8601, UTC)
customer_internal_referencetext- Your reference given when it was created
decisiontext- The overall decision: PASSED, WARNING, REJECTED or NOT_EXECUTED
decision_labeltext- Jumio's label for the decision, such as TOKEN_EXPIRED
document_decisiontext- The ID check's decision
document_labeltext- Jumio's label for it
id_dataobject- What was read off the ID: firstName, lastName, dateOfBirth, documentNumber, expiryDate, issuingCountry and more
liveness_decisiontext- Whether the selfie was of a live person
liveness_labeltext- Jumio's label for it
risk_scorenumber- Risk from 0 (none) to 100 (highest); -1 if it never ran
similaritytext- MATCH, NO_MATCH or NOT_POSSIBLE
similarity_decisiontext- The selfie match check's decision
statustext- INITIATED, ACQUIRED, PROCESSED, SESSION_EXPIRED or TOKEN_EXPIRED
user_referencetext- Your id for the person, if one was given
verificationobject- The whole record, without images
workflow_execution_idtext- The verification's id
workflow_keytext- The workflow it ran, such as 10011
Example output
{
"account_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"checks": [
{
"check": "extraction",
"decision": "PASSED",
"label": "OK"
},
{
"check": "similarity",
"decision": "PASSED",
"label": "MATCH"
},
{
"check": "liveness",
"decision": "PASSED",
"label": "OK"
}
],
"completed_at": "2026-11-17T14:21:44.684Z",
"created_at": "2026-11-17T14:15:22.782Z",
"customer_internal_reference": "application-1042",
"decision": "PASSED",
"decision_label": "PASSED",
"document_decision": "PASSED",
"document_label": "OK",
"id_data": {
"dateOfBirth": "1969-01-18",
"documentNumber": "N1234567",
"expiryDate": "2029-01-18",
"firstName": "JOHN JACOB",
"issuingCountry": "USA",
"lastName": "SMITH",
"state": "CA",
"type": "DRIVING_LICENSE"
},
"liveness_decision": "PASSED",
"liveness_label": "OK",
"risk_score": 0,
"similarity": "MATCH",
"similarity_decision": "PASSED",
"status": "PROCESSED",
"user_reference": "customer-881",
"verification": {
"account": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"capabilities": {
"extraction": [
{
"credentials": [
{
"category": "ID",
"id": "fdb1bc31-99a0-4671-8f2a-2bf7ca2faace"
}
],
"data": {
"dateOfBirth": "1969-01-18",
"documentNumber": "N1234567",
"expiryDate": "2029-01-18",
"firstName": "JOHN JACOB",
"issuingCountry": "USA",
"lastName": "SMITH",
"state": "CA",
"type": "DRIVING_LICENSE"
},
"decision": {
"details": {
"label": "OK"
},
"type": "PASSED"
},
"id": "5483e41e-08a7-4d9d-a09d-9f21e41b9e72"
}
],
"liveness": [
{
"data": {
"type": "JUMIO_STANDARD"
},
"decision": {
"details": {
"label": "OK"
},
"type": "PASSED"
},
"id": "789f4e4a-7c2f-4764-a98d-c519d082ba6d"
}
],
"similarity": [
{
"data": {
"similarity": "MATCH"
},
"decision": {
"details": {
"label": "MATCH"
},
"type": "PASSED"
},
"id": "1fc799e4-f0ba-4dde-aaae-af857eef7b6e"
}
]
},
"completedAt": "2026-11-17T14:21:44.684Z",
"createdAt": "2026-11-17T14:15:22.782Z",
"credentials": [
{
"category": "ID",
"id": "fdb1bc31-99a0-4671-8f2a-2bf7ca2faace",
"parts": [
{
"captureType": "camera",
"classifier": "FRONT"
},
{
"captureType": "camera",
"classifier": "BACK"
}
]
},
{
"category": "SELFIE",
"id": "bce8a24b-16ba-46a8-994e-fa76e4c4845b",
"parts": [
{
"captureType": "camera",
"classifier": "FACE"
}
]
}
],
"decision": {
"details": {
"label": "PASSED"
},
"risk": {
"score": 0
},
"type": "PASSED"
},
"startedAt": "2026-11-17T14:19:50.550Z",
"workflow": {
"customerInternalReference": "application-1042",
"definitionKey": "10011",
"id": "41f71912-1c6b-4e2f-b340-d6dc10cd69b8",
"status": "PROCESSED",
"userReference": "customer-881"
}
},
"workflow_execution_id": "41f71912-1c6b-4e2f-b340-d6dc10cd69b8",
"workflow_key": "10011"
}Get verification rules
List the risk rules a verification was scored by, and which of them matched.
Inputs
- Account
account_idtextRequired - The Jumio account (one per person verified). Pick a recent one, or give its id from an earlier step.
- Verification
workflow_execution_idtextRequired - The verification (Jumio calls it a workflow execution). Pick a recent one, or give its id from an earlier step.
Outputs
countnumber- How many rules matched
executionslist- Each scoring run
rules_matchedlist- Every rule that matched
Example output
{
"count": 0,
"executions": [
{
"completedAt": "2026-11-17T14:21:41.000Z",
"id": "0b2f8f7c-62a5-4e43-9d0c-1f6d8e1f4a11",
"rulesets": [
{
"id": "default",
"name": "Default ruleset",
"rulesMatched": [],
"rulesNotMatched": [
{
"id": "expired-document",
"name": "Expired document",
"score": 100,
"version": 1
}
],
"score": 0,
"version": 3
}
],
"startedAt": "2026-11-17T14:21:40.000Z"
}
],
"rules_matched": []
}Get verification status
Get where a verification is: not started yet, processed, or expired before the person finished.
Inputs
- Account
account_idtextRequired - The Jumio account (one per person verified). Pick a recent one, or give its id from an earlier step.
- Verification
workflow_execution_idtextRequired - The verification (Jumio calls it a workflow execution). Pick a recent one, or give its id from an earlier step.
Outputs
account_idtext- The account
is_finishedtrue/false- True once processed or expired
statustext- INITIATED, ACQUISITION_STARTED, ACQUIRED, PROCESSED, SESSION_EXPIRED or TOKEN_EXPIRED
workflow_execution_idtext- The verification
workflow_keytext- The workflow it runs
Example output
{
"account_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_finished": true,
"status": "PROCESSED",
"workflow_execution_id": "41f71912-1c6b-4e2f-b340-d6dc10cd69b8",
"workflow_key": "10011"
}Get verification steps
List the services a verification ran, each with its decision and the checks it made.
Inputs
- Account
account_idtextRequired - The Jumio account (one per person verified). Pick a recent one, or give its id from an earlier step.
- Verification
workflow_execution_idtextRequired - The verification (Jumio calls it a workflow execution). Pick a recent one, or give its id from an earlier step.
Outputs
countnumber- How many
stepslist- The steps
Example output
{
"count": 1,
"steps": [
{
"capabilities": [
{
"category": "extraction",
"id": "5483e41e-08a7-4d9d-a09d-9f21e41b9e72"
}
],
"capabilityIds": [
"5483e41e-08a7-4d9d-a09d-9f21e41b9e72"
],
"decision": {
"details": {
"label": "PASSED"
},
"type": "PASSED"
},
"id": "73898f70-edd5-4bff-8d15-8f6e9eb81329",
"name": "ID_IV"
}
]
}List recent verifications
List the most recently processed verifications, newest first, each with its account, decision and risk score. Gets one page; to see more, run it again with the next page number.
Inputs
- Page
pagenumber - Which page, starting at 1.From 1 to 10000.
- Page size
page_sizenumber - How many to return, 1 to 100. Jumio's default is 50.From 1 to 100.
Outputs
countnumber- How many on this page
has_moretrue/false- True if the next page may have more
pagenumber- The page read
verificationslist- The verifications, images left out
Example output
{
"count": 1,
"has_more": false,
"page": 1,
"verifications": [
{
"account_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"completed_at": "2026-11-17T14:21:44.684Z",
"created_at": "2026-11-17T14:15:22.782Z",
"customer_internal_reference": "application-1042",
"decision": "PASSED",
"decision_label": "PASSED",
"risk_score": 0,
"status": "PROCESSED",
"user_reference": "customer-881",
"verification": {
"account": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"capabilities": {
"extraction": [
{
"credentials": [
{
"category": "ID",
"id": "fdb1bc31-99a0-4671-8f2a-2bf7ca2faace"
}
],
"data": {
"dateOfBirth": "1969-01-18",
"documentNumber": "N1234567",
"expiryDate": "2029-01-18",
"firstName": "JOHN JACOB",
"issuingCountry": "USA",
"lastName": "SMITH",
"state": "CA",
"type": "DRIVING_LICENSE"
},
"decision": {
"details": {
"label": "OK"
},
"type": "PASSED"
},
"id": "5483e41e-08a7-4d9d-a09d-9f21e41b9e72"
}
],
"liveness": [
{
"data": {
"type": "JUMIO_STANDARD"
},
"decision": {
"details": {
"label": "OK"
},
"type": "PASSED"
},
"id": "789f4e4a-7c2f-4764-a98d-c519d082ba6d"
}
],
"similarity": [
{
"data": {
"similarity": "MATCH"
},
"decision": {
"details": {
"label": "MATCH"
},
"type": "PASSED"
},
"id": "1fc799e4-f0ba-4dde-aaae-af857eef7b6e"
}
]
},
"completedAt": "2026-11-17T14:21:44.684Z",
"createdAt": "2026-11-17T14:15:22.782Z",
"credentials": [
{
"category": "ID",
"id": "fdb1bc31-99a0-4671-8f2a-2bf7ca2faace",
"parts": [
{
"captureType": "camera",
"classifier": "FRONT"
},
{
"captureType": "camera",
"classifier": "BACK"
}
]
},
{
"category": "SELFIE",
"id": "bce8a24b-16ba-46a8-994e-fa76e4c4845b",
"parts": [
{
"captureType": "camera",
"classifier": "FACE"
}
]
}
],
"decision": {
"details": {
"label": "PASSED"
},
"risk": {
"score": 0
},
"type": "PASSED"
},
"startedAt": "2026-11-17T14:19:50.550Z",
"workflow": {
"customerInternalReference": "application-1042",
"definitionKey": "10011",
"id": "41f71912-1c6b-4e2f-b340-d6dc10cd69b8",
"status": "PROCESSED",
"userReference": "customer-881"
}
},
"workflow_execution_id": "41f71912-1c6b-4e2f-b340-d6dc10cd69b8",
"workflow_key": "10011"
}
]
}Report fraud on verification
Tell Jumio whether a verification turned out to be fraud, which helps it tune your risk scoring.
Inputs
- Account
account_idtextRequired - The Jumio account (one per person verified). Pick a recent one, or give its id from an earlier step.
- Verification
workflow_execution_idtextRequired - The verification (Jumio calls it a workflow execution). Pick a recent one, or give its id from an earlier step.
- Verdict
verdicttextRequired - Whether it was fraud.One of:
FRAUD,NOT_FRAUD(Not fraud),NA(Not known (clears earlier feedback)). - Kind of fraud
reasontext - What kind of fraud it was.One of:
IDENTITY_FRAUD(Identity fraud),SYNTHETIC_ID_FRAUD(Synthetic ID fraud),ACCOUNT_TAKEOVER(Account takeover),FIRST_PARTY_FRAUD(First-party fraud),THIRD_PARTY_FRAUD(Third-party fraud),PAYMENT_FRAUD(Payment fraud),MONEY_LAUNDERING(Money laundering),PHISHING,INSIDER_FRAUD(Insider fraud),COMPANY_POLICY(Company policy),GOVERNMENT_REGULATIONS(Government regulations),NA(None given).
Outputs
account_idtext- The account
reasontext- The kind of fraud, if given
savedtrue/false- True once Jumio took it
verdicttext- FRAUD, NOT_FRAUD or NA
workflow_execution_idtext- The verification
Example output
{
"account_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"reason": "IDENTITY_FRAUD",
"saved": true,
"verdict": "FRAUD",
"workflow_execution_id": "41f71912-1c6b-4e2f-b340-d6dc10cd69b8"
}Verify existing account again
Start another verification for someone Jumio already has an account for, such as a returning customer, and get a new link.
Inputs
- Account
account_idtextRequired - The Jumio account (one per person verified). Pick a recent one, or give its id from an earlier step.
- Workflow
workflow_keytextRequired - What Jumio checks, such as ID and selfie. Use a key your Jumio account manager has turned on for you.
- Your reference
customer_internal_referencetextRequired - Your own reference for this verification, such as an application number. No names, emails or other personal details.
- Your ID for the person
user_referencetext - Your own id for the person being verified, such as a customer number. No personal details.
- Reporting label
reporting_criteriatext - A label to search and group verifications by in Jumio.
- Accepted ID types
id_typeslist - Only accept these kinds of ID. Leave empty for every kind.One or more of:
PASSPORT,DRIVING_LICENSE(Driver's license),ID_CARD(ID card),VISA,DIGITAL_IDENTITY(Digital identity). - Accepted ID countries
id_countrieslist - Only accept IDs issued by these countries. Leave empty for every country your Jumio account accepts.One or more of:
AFG(Afghanistan (AFG)),ALA(Åland Islands (ALA)),ALB(Albania (ALB)),DZA(Algeria (DZA)),ASM(American Samoa (ASM)),AND(Andorra (AND)),AGO(Angola (AGO)),AIA(Anguilla (AIA)),ATA(Antarctica (ATA)),ATG(Antigua and Barbuda (ATG)), and 242 more. - Link lasts (minutes)
link_lifetime_minutesnumber - How long the person has to start, from 5 minutes to 60 days. Jumio's default is 30 minutes.From 5 to 86400.
- Language
localetext - The language of the verification page. Defaults to your Jumio setting.One of:
en(English (US)),en-GB(English (UK)),sq(Albanian),ar(Arabic),az(Azerbaijani),bn(Bengali),bn-IN(Bengali (India)),bg(Bulgarian),my-MM(Burmese (Myanmar)),ca(Catalan), and 55 more. - Page after success
success_urltext - An https:// page to send the person to when they finish.
- Page after an error
error_urltext - An https:// page to send the person to if it fails.
- Callback URL
callback_urltext - An https:// address Jumio tells when this verification changes, in place of the one in your Jumio settings.
Outputs
account_idtext- The new verification's account; keep it for later steps
created_attext- When Jumio created it (ISO 8601, UTC)
credentialslist- What the person will be asked for
error_urltext- Where they go after an error, if set
success_urltext- Where they go after finishing, if set
verification_linktext- The link the person opens to photograph their ID and take a selfie
workflow_execution_idtext- The verification's id
Example output
{
"account_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2026-11-17T14:15:22Z",
"credentials": [
{
"allowedChannels": [
"WEB",
"SDK"
],
"category": "ID",
"country": {
"predefinedType": "DEFINED",
"values": [
"USA"
]
},
"id": "fdb1bc31-99a0-4671-8f2a-2bf7ca2faace",
"type": {
"predefinedType": "DEFINED",
"values": [
"DRIVING_LICENSE"
]
}
},
{
"allowedChannels": [
"WEB",
"SDK"
],
"category": "SELFIE",
"id": "bce8a24b-16ba-46a8-994e-fa76e4c4845b"
}
],
"error_url": "https://example.com/not-verified",
"success_url": "https://example.com/verified",
"verification_link": "https://acme.web.amer-1.jumio.ai/web/v4/app?authorizationToken=eyJhbGciOi&locale=en-US",
"workflow_execution_id": "41f71912-1c6b-4e2f-b340-d6dc10cd69b8"
}