API reference · Proof of address capture

Add proof of address

POST/omni/add/address-statement

Base URL: https://demo-api.incodesmile.com — Incode demo environment

Add a proof of address statement as a blob. OCR data from statement will be automatically extracted

Path & query parameters

Name In Type Required Description
format query string Enum: image, pdf
api-version header string yes

Request body

Content-Type: application/json

Responses

200

OK

Response body (application/json):

Field Type Required Description
success boolean Flag indicating request passed successfully.
sessionStatus string Session status Enum: Alive, Closed, Deleted

400

Bad Request

Response body (application/json):

Field Type Required Description
timestamp integer (int64) UTC timestamp in milliseconds
status integer (int32) Custom error code or HTTP status code
error string HTTP status error
message string Custom error message
path string Endpoint path
details object Custom error details
Was this page helpful?