Skip to main content
POST
/
pe
/
rree
/
foreigner-cards
/
v1
RREE Foreigner Cards
curl --request POST \
  --url https://api.croma.run/pe/rree/foreigner-cards/v1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document_number": "00112233"
}
'
{
  "data": {
    "found": true,
    "card_number": "<string>",
    "birth_date": "2023-12-25",
    "last_name": "<string>",
    "first_name": "<string>",
    "nationality": "<string>",
    "expiration_date": "2023-12-25",
    "immigration_status": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Use Authorization: Bearer YOUR_API_KEY

Headers

​
Prefer
string

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.

Example:

"wait=30"

Body

application/json
​
document_number
string
required

8-digit foreigner card number.

Pattern: ^\d{8}$
​
callback_url
string<uri>

POST the job result here when it finishes.

Response

Successful response

​
data
object
required