Analyze file

POST

/analyze

• Production environment

Add a new operation to the platform

Authorizations

• BearerAuth
  role:usage role:pad

Request Body

Fields marked with (*) are optional

object

documentUrl

required

string

documentType

required

string

Allowed values: payroll working-life-document income-document obverse-dni reverse-dni panamanian-dni maritime-migration-coupon personal-documents invoices receipts credit-cards

files

Array<object>

object

slug

An unique file identifier, useful for identifying the resource after analysis

string

url

string

callbackUrl*

An open client endpoint to receive a POST request (e.g., https://api.backend.com/api/v1/callback).

string

payload*

An open field where the client can store any serializable data (e.g., object, string, or number) to associate with the response data after the callback.

object

Responses

200

Synchronous process completed successfully

object

meta

object

code

integer

message

string

data

object

analysisRequestId*

string

pagesCount

integer

fieldsCount

integer

tables

Array<object>

object

fields

Array<object>

object

id

string

type

string

label

string

value

string

202

Asynchronous process started correctly

object

meta

object

code

integer

message

string

data

object

id

string

uuid

string

callback

string

createdAt

string

updatedAt

string

analyses

Array<object>

object

id

string

type

string

slug

string

url

string

callback

string

status

integer

sessionId

string

createdAt

string

updatedAt

string

deletedAt

string

400

Bad Request

object

meta

object

code

integer

message

string

errors

object

reason

string

details

string

values

Array<object>

object

401

Unauthorized

object

meta

object

code

integer

message

string

errors

object

reason

string

details

string

values

Array<object>

object

409

Conflict

object

meta

object

code

integer

message

string

errors

object

reason

string

details

string

values

Array<object>

object

500

Internal Server Error

object

meta

object

code

integer

message

string

errors

object

reason

string

details

string

values

Array<object>

object