Document Verification Verify Service (Upcoming)

Document Verification Verify Service API Documentation

POST /verify

Verify Documents

cURL

curl --request POST \
  --url https://api-umbrella.io/api/services/verify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "journeyId": "uniqueJourneyIdentifier"
}
'

200

{
  "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": "[e-mail]",
    "mobileNumber": "[phone]"
  },
  "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

Authorization · string · header · required

Bearer token obtained from POST /auth. Valid for 60 minutes.

Body

application/json

journeyId · string · required

Unique identifier for the verification journey.

Example:

"uniqueJourneyIdentifier"

Response

200

application/json

Successfully verified documents.

journeyId · string

Unique identifier for the verification journey.

status · string

Status of the verification process.

Example:

"verificationComplete"

identitySubject · object

Show child attributes

authoritativeData · object

Show child attributes

proofOfWork · object

Show child attributes

auditTrail · object

Show child attributes

fraudAlerts · object

Show child attributes

croppedImages · object

Show child attributes