RUAF Affiliations

Look up a person's social-security affiliations in Colombia by document number. Requires the date the document was issued. document_type defaults to CC.

Supports async delivery: set Prefer: wait=N for an inline result, pass callback_url to receive a POST when ready, or poll GET /jobs/{id}.

post/co/ruaf/affiliations/v1

Request

Base URL: https://api.croma.run
URL: https://api.croma.run/co/ruaf/affiliations/v1
Auth: HTTP bearer

Headers

Idempotency-Keystring

Example:0f8e9a42-6b7c-4d1e-9a3f-2c5d7e8f9a0b

Optional client-chosen key for this request (any string up to 255 characters, e.g. a UUID). Every Croma operation is an idempotent lookup: repeating a request with the same body returns the same result and creates nothing, so retrying after a timeout or network failure is always safe. The key is echoed back in the Idempotency-Key response header so you can correlate a retry with its first attempt. Each attempt that reaches the API counts against the rate limit.

Preferstring

Example:wait=30

Set wait=N to hold the connection up to N seconds for an inline result. If the job finishes in time you get the normal 200 body; otherwise a 202 with a status_url to poll.

Request body

document_type'CC' | 'CE' | 'TI' | 'RC' | 'PA' | 'PEP' | 'PPT'

Colombian document type. Defaults to CC.

document_numberstring required

Colombian cédula. 5-12 digits, no leading zero.

issue_datestring date required

Date the document was issued, in yyyy-mm-dd format. For TI and RC, the date of birth.

callback_urlstring uri

POST the job result here when it finishes.

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.