Utils

Validate a CPF/CNPJ (checksum) and, for a CNPJ, enrich it with the company registration

GET
/v1/utils/corporate-document-check

Authorization

selectkey<token>

API key para requisições autenticadas. Envie sua chave no cabeçalho selectkey (sandbox sk_test_…, produção sk_live_…).

In: header

Query Parameters

document*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/utils/corporate-document-check?document=stringstr"
{
  "valid": true,
  "document": "string",
  "type": "cpf",
  "name": "Acme Ltda",
  "fantasyName": "string",
  "email": "[email protected]",
  "telephone": "string",
  "cnae": "string",
  "cnaeDescription": "string",
  "legalNature": "string",
  "openingDate": "string",
  "registrationStatus": "string",
  "registrationStatusDate": "string",
  "active": true,
  "shareCapital": 0,
  "size": "string",
  "simplesOptant": true,
  "meiOptant": true,
  "address": {
    "postcode": "string",
    "street": "string",
    "number": "string",
    "complement": "string",
    "district": "string",
    "city": "string",
    "state": "string",
    "country": "string"
  },
  "secondaryCnaes": [
    {
      "code": "string",
      "description": "string"
    }
  ],
  "partners": [
    {
      "name": "Acme Ltda",
      "qualification": "string",
      "since": "string"
    }
  ],
  "merchant": {
    "name": "Acme Ltda",
    "merchantId": "string",
    "isSubAccount": true
  }
}
{
  "error": {
    "status": "Bad Request",
    "statusCode": 400,
    "category": "validation",
    "code": "invalidParameters",
    "message": "Validation errors occurred.",
    "resource": "server"
  }
}
{
  "error": {
    "status": "Unauthorized",
    "statusCode": 401,
    "category": "authentication",
    "code": "unauthorized",
    "message": "Authentication is required to access this resource.",
    "resource": "server"
  }
}
{
  "error": {
    "status": "Internal Server Error",
    "statusCode": 500,
    "category": "server",
    "code": "serverError",
    "message": "An unexpected error occurred. Please try again later.",
    "resource": "server",
    "details": "If the problem persists, contact support with the correlationId from the response headers."
  }
}