Skip to main content
POST
/
verifySingle
Single-Step Document Verification
curl --request POST \
  --url https://api-umbrella.io/api/services/verifySingle \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "imageName": "<string>",
    "imageSide": "front",
    "imageData": "<string>",
    "storeOnly": true,
    "passThroughData": {}
  }
]
'
{
  "status": true,
  "data": {
    "isVerified": true,
    "status": "completed",
    "message": "<string>",
    "requestId": "<string>",
    "signature": {
      "content": [
        {
          "id": "<string>",
          "method": "<string>",
          "status": "<string>",
          "pageMode": "<string>",
          "signedAt": "2023-11-07T05:31:56Z",
          "plainResource": {
            "id": "<string>",
            "name": "<string>",
            "type": "<string>",
            "family": "<string>",
            "status": "<string>",
            "subType": "<string>",
            "filename": "<string>",
            "metadata": {},
            "mimeType": "<string>",
            "sizeBytes": 123,
            "resourceUri": "<string>",
            "resourceUrl": "<string>",
            "urlValidBefore": "2023-11-07T05:31:56Z"
          },
          "signedResource": {
            "id": "<string>",
            "type": "<string>",
            "family": "<string>",
            "status": "<string>",
            "filename": "<string>",
            "metadata": {},
            "mimeType": "<string>",
            "sizeBytes": 123,
            "resourceUri": "<string>",
            "resourceUrl": "<string>",
            "urlValidBefore": "2023-11-07T05:31:56Z"
          }
        }
      ]
    },
    "identification": {
      "id": "<string>",
      "actor": "<string>",
      "idSelf": {
        "artifacts": {
          "biometry": [
            {}
          ],
          "document": [
            {}
          ]
        },
        "biometryCheck": {
          "keysWithError": [
            "<string>"
          ],
          "controlsSummary": 123
        },
        "documentCheck": {
          "documentType": "<string>",
          "documentTypeFamily": "<string>",
          "keysWithError": [
            "<string>"
          ],
          "controlsSummary": 123
        }
      },
      "source": "<string>",
      "status": "<string>",
      "personData": {
        "email": "jsmith@example.com",
        "gender": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "birthDate": "<string>",
        "birthPlace": "<string>",
        "nationality": "<string>",
        "phoneNumber": "<string>",
        "documentDetails": {
          "type": "<string>",
          "number": "<string>",
          "issuedOn": "<string>",
          "expiryDate": "<string>",
          "issuanceCountry": "<string>",
          "issuanceAuthority": "<string>"
        }
      },
      "finalizedAt": "2023-11-07T05:31:56Z",
      "organizationId": "<string>",
      "validationDetail": {}
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://umbrella-docs.info/llms.txt

Use this file to discover all available pages before exploring further.

For a usage description of the Document Verification Verify Single Service, please refer to the Document Verification page.

​
Endpoint

POST /verifySingle

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
imageName
string
required

Name of the uploaded image file

​
imageSide
enum<string>
required

Specifies which side of the document (front, back, selfie)

Available options:
front,
back,
selfie
​
imageData
string
required

Base64-encoded image or multipart file

​
storeOnly
boolean

If true, stores the image without classification

​
passThroughData
object

Custom metadata (e.g., user ID)

Response

Verification successful

​
status
boolean
required

Indicates whether the request succeeded.

​
data
object
required

Verification payload.