Get document
Document API
Get Document
Retrieve a document by its unique identifier. Returns the complete document record including processing status, extracted data, and fraud detection results.
Document Status Values:
pending: Document created but file not yet uploadedsubmitted: File uploaded, queued for processingprocessing: Currently being processedprocessed: Processing completed successfullyfailed: Processing failed (check error details)
Use Cases:
- Check document processing status
- Retrieve extracted data after processing completes
- Access fraud detection analysis results
Sparse Fieldsets (JSON:API):
- Use
fields[document]with a comma-separated list to return only specific fields (attributes and relationships) idandtypeare always returned; an empty value returns onlyid/type- Omit the parameter to return all fields
- Unknown field names return
400 Bad Request
GET
Get document
Authorizations
API key for authentication. Access https://console.beltic.com/ to obtain your API key.
Path Parameters
Document ID
Query Parameters
Sparse fieldset: comma-separated list of document fields (attributes and relationships) to return. An empty value returns only id/type. Omit the parameter to return all fields.
Example:
"status,file"
Response
Document found successfully