Skip to navigation

Public Position

View as Markdown

One answer with every official record the execution retrieved — the unified position of your customer across the administrations it reached: identity, academic records, driver and vehicles, employment and pensions, tax, properties and the credit registry, each family under its own key. The keys are described in Data models.

This is the read we recommend, and the one to build on. Every family below also has its own endpoint — Labor check, Credit registry, and the rest — and they answer the same records. The difference is the number of requests: one here, up to ten there, for the same execution and the same data.

Reach for a single family when you genuinely want one — an employment check on its own — and for anything that reasons over the whole person come here.

Only what was requested appears. A family that was not asked for, or that the administration did not answer, is absent rather than empty. Nothing here fails because a feature is missing — so read the keys rather than assuming them.

StatusMeaning
200The position.
202execution_still_processing — this endpoint waits for the whole execution, unlike the per-family ones: a partial picture of somebody’s official records is a misleading one.
404No execution with that id for your application, or it has been deleted.

Server to server only. This call is authorised with your application secret: it belongs in your backend, never in a browser, a mobile app or anything your customer can read.

Authentication

X-APP-SECRETstring
Application Secret

Path parameters

execution_idstringRequiredformat: "object-id"
The execution, as the acceptance response returned it.

Response

200 OK
Everything the execution retrieved from the administrations, assembled into one object — identity, academic, driver, employment, tax, properties and credit — each under its own family. A family the execution did not ask for is absent.

customerobjectOptional
Customer family
academicobjectOptional
Academic family
driverobjectOptional

Driver & vehicles family

employmentobjectOptional
Employment family
taxobjectOptional
Tax family
propertiesobjectOptional
Properties family
creditobjectOptional
Credit registry family

Errors

404
Not Found Error
422
Unprocessable Entity Error