Document Analysis

Analyze an uploaded government-issued ID or passport image, extract structured fields, and return verification results.

Request

POST/api/v1/document/analysis

{{baseUrl}}/api/v1/document/analysis

Header

Header	Type	Description
Authorization	string	`Bearer YOUR_ACCESS_TOKEN` from the OAuth client-credentials flow
Content-Type	string	application/json

Body Parameters

Parameter	Type	Description	Required
image_front	string	Base64 or URL of the document front	required
image_back	string	Base64 or URL of the document back	optional
doc_type	string	id_card \| passport \| drivers_license	optional
consent	boolean	Must be true — confirms data-subject consent to perform this verification	required

Sample request body

All verification APIs require consent: true in the JSON body.

Sample dataSample request body

{
  "image_front": "https://cdn.example.com/sample.jpg",
  "image_back": "https://cdn.example.com/sample.jpg",
  "doc_type": "sample-value",
  "consent": true
}

Response

200 OKSample dataExample response

{
  "success": true,
  "response_code": 200,
  "message": "Document analysis completed",
  "data": {
    "status": "success",
    "doc_type": "id_card",
    "extracted": {
      "full_name": "Jane Doe",
      "id_number": "1028845317",
      "dob": "1990-01-15"
    },
    "confidence": 0.97
  },
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

Response Fields

Field	Type	Description
success	boolean	Whether the request succeeded
response_code	number	Application response code (typically mirrors HTTP)
message	string	Human-readable status message
data	object	Payload for the verified resource
request_id	string	UUID for support and audit trails

Set {{baseUrl}} to https://api.peleza.com (production) or https://sandbox.peleza.com (sandbox). Authenticated calls need a Bearer token from POST /api/v1/oauth/token.