BrazID API

BrazID API as documented publicly: 8 operations. Contract generated from the documentation by API Evangelist (2026-11-16); not the provider's own document.

GitHub OpenAPI

Operations 8

GET /v1/cnpj/batch/{id} Batch completed event – fetch results #
POST /v1/compliance/cpf POST /v1/compliance/cpf #
GET /v1/compliance/cpf/{id} Compliance & Background Check #
POST /v1/cpf/batch POST /v1/cpf/batch #
GET /v1/cpf/batch/{id} Batch completed event – fetch results #
POST /v1/cpf/live POST /v1/cpf/live #
GET /v1/me GET /v1/me #
POST /v1/validate POST /v1/validate confere #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/brazid-com:brazid-com-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

brazid-com-openapi-generated.yml Raw ↑
openapi: 3.1.0
info:
  title: BrazID API
  version: '2026-11-16'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-16: 8 operation(s) read from 14 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; BrazID has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 6
    documentation: 2
    pages-with-code: 10
    pages-read: 14
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-16'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://brazid.com/docs/webhooks
  - https://brazid.com/en/docs/webhooks
  - https://brazid.com/es/docs/webhooks
  - https://brazid.com/en/docs/quickstart
  - https://brazid.com/docs/quickstart
  - https://brazid.com/es/docs/quickstart
  - https://brazid.com/docs/authentication
  - https://brazid.com/docs/sandbox
  - https://brazid.com/docs/simple-lookup
  - https://brazid.com/docs/official-lookup
  - https://brazid.com/docs/batch
  - https://brazid.com/docs/batch-status
  - https://brazid.com/docs/compliance
  - https://brazid.com/docs/compliance-status
servers:
- url: https://api.brazid.com
paths:
  /v1/cnpj/batch/{id}:
    get:
      operationId: get_v1_cnpj_batch_id
      tags:
      - Cnpj
      summary: Batch completed event – fetch results
      x-source: https://brazid.com/docs/webhooks
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/compliance/cpf:
    post:
      operationId: post_v1_compliance_cpf
      tags:
      - Compliance
      summary: POST /v1/compliance/cpf
      x-source: https://brazid.com/docs/compliance
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1ComplianceCpfRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl Node.js Python PHP cURL Copiar 1 curl -X POST https://api.brazid.com/v1/compliance/cpf \ 2 -H "x-api-key: $BRAZID_API_KEY"
          \ 3 -H "Content-Type: application/json" \ 4 -d ''{"cpf":"11144477735","description":"Prevenção à lavagem de dinheiro","birthdate":"1985-05-12","callback_url":"https://example.com/hooks/brazid"}''
          1 const res = await fetch( ''https://api.brazid.com/v1/compliance/cpf'' , { 2 me'
  /v1/compliance/cpf/{id}:
    get:
      operationId: get_v1_compliance_cpf_id
      tags:
      - Compliance
      summary: Compliance & Background Check
      description: Consulta o resultado de uma verificação de Compliance & Background Check criada anteriormente.
      x-source: https://brazid.com/docs/compliance
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/cpf/batch:
    post:
      operationId: post_v1_cpf_batch
      tags:
      - Cpf
      summary: POST /v1/cpf/batch
      x-source: https://brazid.com/docs/sandbox
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                properties:
                  cpf:
                    type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl Node.js Python PHP cURL Copiar 1 curl -X POST https://api-sandbox.brazid.com/v1/cpf/batch \ 2 -H "x-api-key: $BRAZID_API_KEY"
          \ 3 -H "Content-Type: application/json" \ 4 -d ''[{"cpf":"52998224725"},{"cpf":"30000000116"},{"cpf":"30000000388"},{"cpf":"00000000191"},{"cpf":"99999999050"},{"cpf":"52998224726"}]''
          1 const res = await fetch( ''https://api-sandbox.brazid.com/v1/cpf/batch'' , { 2 method:'
  /v1/cpf/batch/{id}:
    get:
      operationId: get_v1_cpf_batch_id
      tags:
      - Cpf
      summary: Batch completed event – fetch results
      x-source: https://brazid.com/docs/webhooks
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/cpf/live:
    post:
      operationId: post_v1_cpf_live
      tags:
      - Cpf
      summary: POST /v1/cpf/live
      x-source: https://brazid.com/en/docs/quickstart
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1CpfLiveRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl Node.js Python PHP cURL Copy 1 curl -X POST https://api.brazid.com/v1/cpf/live \ 2 -H "x-api-key: $BRAZID_API_KEY" \ 3
          -H "Content-Type: application/json" \ 4 -d ''{"cpf":"52998224725","birthdate":"1982-11-26"}'' 1 const res = await fetch( ''https://api.brazid.com/v1/cpf/live''
          , { 2 method: ''POST'' , 3 headers: { 4 ''x-api-key'' : process.env.BRAZID_API_KEY, 5 ''Content-Type'' : ''application/json'' , '
  /v1/me:
    get:
      operationId: get_v1_me
      tags:
      - Me
      summary: GET /v1/me
      description: Returns information about the authenticated account. Requires the x-api-key header.
      x-source: https://brazid.com/docs/authentication
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1MeResponse'
      x-evidence:
        kind: documentation
  /v1/validate:
    post:
      operationId: post_v1_validate
      tags:
      - Validate
      summary: POST /v1/validate confere
      x-source: https://brazid.com/docs/sandbox
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostV1ComplianceCpfRequest:
      type: object
      properties:
        cpf:
          type: string
        description:
          type: string
        birthdate:
          type: string
          format: date
        callback_url:
          type: string
    PostV1CpfLiveRequest:
      type: object
      properties:
        cpf:
          type: string
        birthdate:
          type: string
          format: date
    GetV1MeResponse:
      type: object
      properties:
        error:
          type: string
          description: Invalid or missing API key
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
security:
- apiKey: []
tags:
- name: Cnpj
- name: Compliance
- name: Cpf
- name: Me
- name: Validate