Overview
Correios API provides integration with Brazil's national postal service, allowing you to calculate shipping costs, generate shipping labels, and track packages. It is essential for Brazilian e-commerce businesses that ship via the official postal network. Authentication requires credentials from a registered Correios business account.
Beginner Tip
Correios uses a token-based auth system — first authenticate at the auth endpoint to get a JWT token, then use that token in subsequent API calls. Tokens expire, so build a refresh mechanism into your integration from the start.
Available Data
The kind of data this API exposes, based on its documentation. We could not call the endpoint to confirm the exact field names.
Example Response
Illustrative shape only — we were not able to call this endpoint (it requires credentials or exposes no public sample URL), so the fields below show the kind of data this API returns rather than a recorded response.
{
"status": "success",
"data": {
"result": "Data from Correios",
"description": "Integration to provide information and prepare shipments using Correio's services",
"timestamp": "2025-01-15T10:00:00Z"
}
} Field Reference
token JWT access token required for all subsequent API requests expiraEm Token expiration datetime in ISO 8601 format cartaoPostagem.numero The posting card number associated with this authentication session cartaoPostagem.contrato Contract number linked to the posting card for billing purposes Implementation Example
Calls a real endpoint of this API. Replace any placeholder credentials with your own key.
const url = "https://cws.correios.com.br/ajuda";
// Replace headers or query params with the values required by this API.
const response = await fetch(url, {
headers: {
"X-API-Key": "YOUR_API_KEY"
}
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();
console.log(data); What Can You Build?
Note: These code examples are AI-generated and unverified. Always refer to the official API documentation for accurate usage.
Common Errors & Troubleshooting
Generated guidance based on this API's documentation, not observed by us. Treat it as a starting point and check against the provider's own error reference.
Metadata Score Breakdown
Estimated from metadata — endpoint not independently tested
Metadata estimate · endpoint not independently tested
Technical Specifications
Related Tags
Similar APIs
View All →Aftership
Aftership is a shipment tracking API that aggregates tracking data from over 900 carriers worldwide into a single unified interface.
PostNord
PostNord is the official API for Sweden and Denmark's postal service, providing real-time tracking information for parcels in transit.
WeCanTrack
WeCanTrack is an affiliate tracking API that automatically appends subids to affiliate links, letting you tie every click back to its source.
Pixela
⭐ Beginner's PickPixela is a fun and lightweight API for tracking habits, daily efforts, and personal goals using pixel-style activity graphs similar to GitHub contribution charts.
WhatPulse
⭐ Beginner's PickWhatPulse is a free public API that exposes keyboard, mouse, and network usage statistics collected by the WhatPulse desktop application.