Skip to main content

Retrieving a profile's documents

curl '<base_url>/api/v2/profile/<profile_uuid>/documents?archived=false' \
-H 'Authorization: Bearer <profile_token>' \

NOTE: When a new document is uploaded, previously uploaded document on the same step will be archived.

You can retrieve the archived documents by sending ?archived=true in the query parameters of request.

Response includes list of all documents' details.

[
{
"id": "document_uuid",
"expiry_date": "document_expiry_date",
"pages": [
{
"id": "page_uuid",
"page": int page_number,
"original_image": "uploaded_image_url",
"processed_image": "cropped_image_url",
"extraction_result": {
// Extracted data from the page
},
"mrz_info": null,
},
],
"rules": [
// list of applied validations
],
"features": [
// extracted data
],
"document_type": {
"name": "Document Type",
"code": "Type Code",
"document_class": "Type Class"
},
"archived": true/false,
"approved": true/false,
"passed": true/false,
"extras": {
"ip": "ip",
"cropped": "true/false",
"rotated": "true/false",
"location": null,
"nfc_status": true/false,
"user_agent": "User Agent",
"device_data": null,
"uploaded_type": {
"type": "type",
"class": "class"
},
"request_language": "en/tr",
"profile_version_number": int
},
"profile": "profile_uuid",
"user": "uploaded_by_user_uuid",
"nfc_data": null,
"selfie_models": null,
"video_records": [],
"created_at": "created_at",
"updated_at": "updated_at",
"reject_reason": "rejection reason",
"signed": true/false,
"attempt": int,
"mrz_from_nfc": null,
"upload_source": upload_source_int_value,
"stream": true/false,
"overridden": true/false,
"videocall": null,
"tiers": [],
"step": null
},
]