Quickstart

This walkthrough creates a registered letter (shipType=2) and tracks it.

1. Check your balance

curl "https://app.escrybe.com.br/api/v2/balance/YOUR_TOKEN"

Response

{ "status": 200, "status_message": "Sucesso", "data": { "account_balance": 12.50, "total_val_pending_jobs": 47.97, "dif_account_balance": 35.47 } }

dif_account_balance is how much you still need to deposit for every pending order to be processed (total_val_pending_jobs - account_balance), floored at 0 — not the remaining balance. When your balance already covers the pending orders it comes back as 0.

2. Validate before paying (optional)

Send test=1 to validate the payload and PDF without creating the order or charging credits.

test accepts 1/true/yes/on for validation and 0/false/no/off for a real submission. Any other value is rejected with 400 — it is never treated as “not a test”. Sending test=2 used to create a real, billable order.

curl -X POST "https://app.escrybe.com.br/api/v2/post" \
  -F "userSecurityToken=YOUR_TOKEN" \
  -F "shipType=2" \
  -F "test=1" \
  -F "name=Maria Silva" \
  -F "addr1=Rua das Flores" \
  -F "street_number=100" \
  -F "zip=01001000" \
  -F "city=São Paulo" \
  -F "state=SP" \
  -F "country=Brasil" \
  -F "name_sender=Minha Empresa LTDA" \
  -F "addr1_sender=Av. Paulista" \
  -F "street_number_sender=1000" \
  -F "zip_sender=01310100" \
  -F "city_sender=São Paulo" \
  -F "state_sender=SP" \
  -F "country_sender=Brasil" \
  -F "pdfFile=@/path/to/letter.pdf"

The sender block is all-or-nothing. To use a request sender, send name_sender, street_number_sender, zip_sender and country_sender. addr1_sender, city_sender and state_sender go all three together or none of them — when omitted, they come from the CEP. If any of the four is missing, or only part of the three is sent, the whole block is taken from your account profile — including the fields you did send, which are silently overwritten. If the profile has no CEP you get a 400.

3. Create the order

Drop test=1 to actually submit. The data field returns the order’s visual id — store it.

Response

{ "status": 200, "status_message": "Sucesso - pedido aceito", "data": "2607031" }

4. Track the order

curl "https://app.escrybe.com.br/api/v2/get/YOUR_TOKEN/2607031"

The status field follows this lifecycle:

Code	Meaning
0	Processing
1	Production
2	Insufficient credits
3	Printed
4	Posted
5	Cancelled
6	Returned

Once tracking is populated, you can follow the Correios tracking code, and download the submitted PDF, envelope front, return receipt (AR) or sender’s copy via /api/v2/download/{securityToken}/{job_id}/{type}.

Get Started

Products

Integrations

1. Check your balance

2. Validate before paying (optional)

3. Create the order

4. Track the order

​1. Check your balance

​2. Validate before paying (optional)

​3. Create the order

​4. Track the order

1. Check your balance

2. Validate before paying (optional)

3. Create the order

4. Track the order