Skip to main content
POST
/
identity
/
extract
Extract document data
curl --request POST \
  --url https://api.txcloud.io/v1/identity/extract \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document_front": "aSDinaTvuI8gbWludGxpZnk=",
  "document_type": "<string>",
  "country": "<string>",
  "document_back": "aSDinaTvuI8gbWludGxpZnk="
}
'
{
  "id": "<string>",
  "object": "identity.extraction",
  "extracted_data": {
    "document_number": "AE123456",
    "first_name": "Mohammed",
    "last_name": "El Amrani",
    "first_name_arabic": "<string>",
    "last_name_arabic": "<string>",
    "date_of_birth": "2023-12-25",
    "gender": "M",
    "nationality": "<string>",
    "issue_date": "2023-12-25",
    "expiry_date": "2023-12-25",
    "address": "<string>",
    "place_of_birth": "<string>",
    "mrz": "<string>",
    "field_confidences": {}
  },
  "field_confidences": {},
  "quality_score": 123
}

Authorizations

Authorization
string
header
required

API key as Bearer token

Body

application/json
document_front
string<byte>
required
document_type
string
required
country
string
required
document_back
string<byte>

Response

Extraction successful

id
string
object
enum<string>
Available options:
identity.extraction
extracted_data
object
field_confidences
object
quality_score
number