Endpoints
- Address Verification
- AML
- Document Verification
- Identity Verification
- KYB
- Payment Services
- Phone Status
Document Verification Verify Service
Document Verification Verify Service API Documentation
curl --request POST \
--url https://api-umbrella.io/api/services/verify \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"journeyId": "uniqueJourneyIdentifier"
}'{
"journeyId": "<string>",
"status": "verificationComplete",
"identitySubject": {
"type": "person",
"fullName": "Max Mustermann",
"nameStructure": {
"firstName": "Max",
"lastName": "Mustermann",
"nativeFullName": "Max Mustermann"
},
"gender": "M",
"nationality": "DE",
"dob": "1990/01/01",
"addressSingleLine": "123 Main St, City, Country",
"email": "max.mustermann@example.com",
"mobileNumber": "+1234567890"
},
"authoritativeData": {
"identityDocument": {
"type": "passport",
"idNumber": "123456789",
"issuingCountry": "DE",
"expeditor": "BH Neunkirchen",
"expirationDate": "2030/01/01",
"verificationChannel": "optical"
}
},
"proofOfWork": {
"type": "image",
"titleOfProof": "IDFront",
"timestampOfProof": "2024/08/01T10:00:00Z"
},
"auditTrail": {
"workId": "abc123",
"workStatus": "PASS",
"workStartTst": "2024/08/01T10:00:00Z",
"workEndTst": "2024/08/01T10:01:00Z",
"workResult": "Verification successful"
},
"fraudAlerts": {
"fraudAlertDetail": [
{}
],
"aggregateFraudAlertScore": 0
},
"croppedImages": {
"front": "<string>",
"portrait": "<string>",
"signature": "<string>",
"back": "<string>",
"selfie": "<string>"
}
}For a usage description of the Document Verification Verify Service, please refer to the Document Verification page.
Endpoint
POST /verify
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Unique identifier for the verification journey.
"uniqueJourneyIdentifier"
Response
Unique identifier for the verification journey.
Status of the verification process.
"verificationComplete"
Type of identity subject.
"person"
Full name as extracted from the document.
"Max Mustermann"
Gender (M, F, or X).
M, F, X "M"
Nationality code (ISO 3166).
"DE"
Date of birth (YYYY/MM/DD).
"1990/01/01"
Extracted address in single-line format.
"123 Main St, City, Country"
Extracted email (if available).
"max.mustermann@example.com"
Extracted mobile number (if available).
"+1234567890"
Type of document.
"passport"
Document ID number.
"123456789"
Country that issued the document.
"DE"
Issuing authority.
"BH Neunkirchen"
Expiry date of the document (YYYY/MM/DD).
"2030/01/01"
How verification was performed.
"optical"
Unique ID of the verification attempt.
"abc123"
Status of the work.
PASS, FAIL "PASS"
Timestamp when the verification started.
"2024/08/01T10:00:00Z"
Timestamp when the verification ended.
"2024/08/01T10:01:00Z"
Summary of the verification result.
"Verification successful"
Base64-encoded image of the front side.
Base64-encoded portrait image from the document.
Base64-encoded signature image.
Base64-encoded image of the back side.
Base64-encoded selfie image (if applicable).
curl --request POST \
--url https://api-umbrella.io/api/services/verify \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"journeyId": "uniqueJourneyIdentifier"
}'{
"journeyId": "<string>",
"status": "verificationComplete",
"identitySubject": {
"type": "person",
"fullName": "Max Mustermann",
"nameStructure": {
"firstName": "Max",
"lastName": "Mustermann",
"nativeFullName": "Max Mustermann"
},
"gender": "M",
"nationality": "DE",
"dob": "1990/01/01",
"addressSingleLine": "123 Main St, City, Country",
"email": "max.mustermann@example.com",
"mobileNumber": "+1234567890"
},
"authoritativeData": {
"identityDocument": {
"type": "passport",
"idNumber": "123456789",
"issuingCountry": "DE",
"expeditor": "BH Neunkirchen",
"expirationDate": "2030/01/01",
"verificationChannel": "optical"
}
},
"proofOfWork": {
"type": "image",
"titleOfProof": "IDFront",
"timestampOfProof": "2024/08/01T10:00:00Z"
},
"auditTrail": {
"workId": "abc123",
"workStatus": "PASS",
"workStartTst": "2024/08/01T10:00:00Z",
"workEndTst": "2024/08/01T10:01:00Z",
"workResult": "Verification successful"
},
"fraudAlerts": {
"fraudAlertDetail": [
{}
],
"aggregateFraudAlertScore": 0
},
"croppedImages": {
"front": "<string>",
"portrait": "<string>",
"signature": "<string>",
"back": "<string>",
"selfie": "<string>"
}
}