> ## Documentation Index
> Fetch the complete documentation index at: https://developers.useqx.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Criar um contato

> Cria uma pessoa pelo CPF ou uma empresa pelo CNPJ. O QX consulta o CPF ou o CNPJ depois da criação, e o `lookup_status` mostra o andamento da consulta. A criação conta no limite de escritas pagas da chave.



## OpenAPI

````yaml /openapi.yaml post /contacts
openapi: 3.1.0
info:
  title: QX API
  version: 1.0.0
  description: >-
    A API do QX cria e lê os contatos, as coletas e os documentos da organização
    e lista os pacotes. Cada chamada leva a chave de API da organização.
servers:
  - url: https://app.useqx.com/api/v1
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Coletas
    description: >-
      As coletas da organização. A coleta pede ao contato os documentos de um
      pacote.
  - name: Contatos
    description: >-
      As pessoas e as empresas da organização. A pessoa tem um CPF, e a empresa
      tem um CNPJ.
  - name: Documentos
    description: >-
      Os documentos da organização. O documento enviado sem coleta entra na
      Triagem, e o documento enviado com coleta ocupa o slot do tipo.
  - name: Pacotes
    description: Os pacotes da organização e os requisitos de cada pacote.
paths:
  /contacts:
    post:
      tags:
        - Contatos
      summary: Criar um contato
      description: >-
        Cria uma pessoa pelo CPF ou uma empresa pelo CNPJ. O QX consulta o CPF
        ou o CNPJ depois da criação, e o `lookup_status` mostra o andamento da
        consulta. A criação conta no limite de escritas pagas da chave.
      operationId: createContact
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactInput'
            examples:
              company:
                summary: Uma empresa pelo CNPJ
                value:
                  tax_id: 12.345.678/0001-95
                  email: fiscal@importadora.com.br
                  name: Importadora Exemplo Ltda
              person:
                summary: Uma pessoa pelo CPF, sem nome
                value:
                  tax_id: 529.982.247-25
                  email: maria.souza@exemplo.com.br
      responses:
        '201':
          description: O contato criado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Contact'
              examples:
                company:
                  summary: A empresa criada, com a consulta do CNPJ em curso
                  value:
                    id: com_12
                    type: company
                    name: Importadora Exemplo Ltda
                    trade_name: null
                    email: fiscal@importadora.com.br
                    tax_id: '12345678000195'
                    lookup_status: pending
                    discarded: false
                    origin: contact
                    created_at: '2026-09-25T10:30:00.000-03:00'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          description: >-
            A organização já tem um contato com este CPF ou CNPJ, e o campo
            `contact` traz esse contato. O contato pode estar arquivado, ou ser
            um sócio que a consulta do CNPJ criou. A resposta `409` também chega
            quando outra chamada com o mesmo `Idempotency-Key` ainda está em
            curso.
          content:
            application/problem+json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ContactExistsProblem'
                  - $ref: '#/components/schemas/IdempotencyKeyInUseProblem'
              examples:
                contact_exists:
                  summary: A organização já tem um contato com este CNPJ
                  value:
                    type: about:blank
                    title: Conflict
                    status: 409
                    detail: >-
                      A organização já tem um contato com este CPF ou CNPJ. O
                      campo contact traz esse contato.
                    code: contact_exists
                    contact:
                      id: com_12
                      type: company
                      name: Importadora Exemplo Ltda
                      trade_name: Exemplo
                      email: fiscal@importadora.com.br
                      tax_id: '12345678000195'
                      lookup_status: completed
                      discarded: false
                      origin: contact
                      created_at: '2026-09-25T10:30:00.000-03:00'
                idempotency_key_in_use:
                  $ref: '#/components/examples/IdempotencyKeyInUse'
        '422':
          description: >-
            Um campo tem erro, e a lista `errors` diz o erro de cada campo. A
            resposta `422` também chega quando o `Idempotency-Key` já atendeu
            uma chamada com outro conteúdo.
          content:
            application/problem+json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ValidationProblem'
                  - $ref: '#/components/schemas/IdempotencyKeyReusedProblem'
              examples:
                validation_failed:
                  summary: O CPF ou o CNPJ não é válido
                  value:
                    type: about:blank
                    title: Unprocessable Content
                    status: 422
                    detail: >-
                      Um ou mais campos têm erro. A lista errors diz o erro de
                      cada campo.
                    code: validation_failed
                    errors:
                      - field: tax_id
                        code: invalid
                        message: O valor não é um CPF válido nem um CNPJ válido.
                idempotency_key_reused:
                  $ref: '#/components/examples/IdempotencyKeyReused'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >-
        Um valor único que o seu sistema cria para cada escrita, como um UUID. A
        chamada repetida com o mesmo valor e o mesmo conteúdo recebe a primeira
        resposta e não grava nada de novo. A API guarda a resposta por 24 horas.
      schema:
        type: string
        minLength: 1
        maxLength: 255
      example: 5f0c7e8a-3a1b-4d2e-9c61-2b7f4e0d9a13
  schemas:
    ContactInput:
      type: object
      required:
        - tax_id
        - email
      properties:
        tax_id:
          type: string
          description: >-
            O CPF da pessoa ou o CNPJ da empresa, com ou sem pontuação. O CNPJ
            pode ter letras nas doze primeiras posições. O valor decide o tipo
            do contato.
          examples:
            - 12.345.678/0001-95
        email:
          type: string
          format: email
          description: O e-mail do contato.
          examples:
            - fiscal@importadora.com.br
        name:
          type: string
          description: >-
            O nome do contato. Sem nome, o contato recebe o nome que a consulta
            do CPF ou do CNPJ traz.
          examples:
            - Importadora Exemplo Ltda
    Contact:
      type: object
      additionalProperties: false
      required:
        - id
        - type
        - name
        - trade_name
        - email
        - tax_id
        - lookup_status
        - discarded
        - origin
        - created_at
      properties:
        id:
          type: string
          pattern: ^(per|com)_[1-9][0-9]*$
          description: >-
            O id do contato. O id da pessoa começa com `per_`, e o id da empresa
            começa com `com_`.
          examples:
            - com_12
        type:
          type: string
          enum:
            - person
            - company
          description: '`person` para a pessoa e `company` para a empresa.'
        name:
          type:
            - string
            - 'null'
          description: >-
            O nome do contato. O valor é `null` até a consulta do CPF ou do CNPJ
            trazer o nome.
          examples:
            - Importadora Exemplo Ltda
        trade_name:
          type:
            - string
            - 'null'
          description: O nome fantasia da empresa. Na pessoa, o valor é `null`.
          examples:
            - Exemplo
        email:
          type:
            - string
            - 'null'
          description: O e-mail do contato, em minúsculas.
          examples:
            - fiscal@importadora.com.br
        tax_id:
          type:
            - string
            - 'null'
          description: >-
            O CPF da pessoa ou o CNPJ da empresa, sem pontuação e com as letras
            em maiúscula. O valor é `null` na pessoa que espera a confirmação do
            CPF.
          examples:
            - '12345678000195'
        lookup_status:
          type: string
          enum:
            - not_enqueued
            - pending
            - completed
            - failed
            - stale
            - needs_review
          description: >-
            O andamento da consulta do CPF ou do CNPJ. `not_enqueued`: a
            consulta não começou. `pending`: a consulta está em curso.
            `completed`: a consulta terminou. `failed`: a consulta falhou.
            `stale`: os dados da consulta estão velhos. `needs_review`: a pessoa
            espera a confirmação do CPF.
        discarded:
          type: boolean
          description: Com `true`, o contato está arquivado.
        origin:
          type: string
          enum:
            - contact
            - shareholder
          description: >-
            `contact` para o contato que a organização criou. `shareholder` para
            o sócio que a consulta do CNPJ criou.
        created_at:
          type: string
          format: date-time
          description: A data e a hora da criação, no fuso horário da organização.
          examples:
            - '2026-09-25T10:30:00.000-03:00'
    ContactExistsProblem:
      description: A organização já tem um contato com este CPF ou CNPJ.
      allOf:
        - $ref: '#/components/schemas/Problem'
        - type: object
          required:
            - contact
          properties:
            code:
              enum:
                - contact_exists
            contact:
              $ref: '#/components/schemas/Contact'
    IdempotencyKeyInUseProblem:
      description: Outra chamada com o mesmo `Idempotency-Key` ainda está em curso.
      allOf:
        - $ref: '#/components/schemas/Problem'
        - type: object
          properties:
            code:
              enum:
                - idempotency_key_in_use
    ValidationProblem:
      description: Um erro de validação. A lista `errors` diz o erro de cada campo.
      allOf:
        - $ref: '#/components/schemas/Problem'
        - type: object
          required:
            - errors
          properties:
            code:
              enum:
                - validation_failed
            errors:
              type: array
              items:
                $ref: '#/components/schemas/FieldError'
    IdempotencyKeyReusedProblem:
      description: O `Idempotency-Key` já atendeu uma chamada com outro conteúdo.
      allOf:
        - $ref: '#/components/schemas/Problem'
        - type: object
          properties:
            code:
              enum:
                - idempotency_key_reused
    Problem:
      type: object
      description: Um erro no formato da RFC 9457.
      required:
        - type
        - title
        - status
        - detail
        - code
      properties:
        type:
          type: string
          const: about:blank
          description: Sempre `about:blank`.
        title:
          type: string
          description: A frase do status HTTP, em inglês.
          examples:
            - Unauthorized
        status:
          type: integer
          description: O status HTTP.
          examples:
            - 401
        detail:
          type: string
          description: A explicação do erro, em português.
        code:
          type: string
          description: O código do erro, em inglês. O código não muda entre versões da v1.
    FieldError:
      type: object
      additionalProperties: false
      required:
        - field
        - code
        - message
      properties:
        field:
          type: string
          description: O nome do campo com o erro.
        code:
          type: string
          description: O código do erro do campo, em inglês.
        message:
          type: string
          description: A explicação do erro do campo, em português.
  responses:
    BadRequest:
      description: Um parâmetro falta ou tem um valor inválido.
      content:
        application/problem+json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Problem'
              - type: object
                properties:
                  code:
                    enum:
                      - invalid_parameter
          examples:
            invalid_parameter:
              summary: O limit passa de 100
              value:
                type: about:blank
                title: Bad Request
                status: 400
                detail: O parâmetro limit tem um valor inválido.
                code: invalid_parameter
    Unauthorized:
      description: A chave falta, não existe ou está revogada.
      headers:
        WWW-Authenticate:
          $ref: '#/components/headers/WwwAuthenticate'
      content:
        application/problem+json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Problem'
              - type: object
                properties:
                  code:
                    enum:
                      - unauthorized
          examples:
            unauthorized:
              summary: A chave falta ou não vale
              value:
                type: about:blank
                title: Unauthorized
                status: 401
                detail: >-
                  A chamada não trouxe uma chave de API válida. Envie a chave no
                  cabeçalho Authorization, no formato Bearer <chave>.
                code: unauthorized
    PaymentRequired:
      description: A assinatura da organização está bloqueada.
      content:
        application/problem+json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Problem'
              - type: object
                properties:
                  code:
                    enum:
                      - subscription_blocked
          examples:
            subscription_blocked:
              summary: A assinatura está bloqueada
              value:
                type: about:blank
                title: Payment Required
                status: 402
                detail: >-
                  A assinatura da organização está bloqueada. Regularize o
                  pagamento no QX para usar a API.
                code: subscription_blocked
    Forbidden:
      description: >-
        A organização está arquivada, ou o plano da organização não inclui a
        API.
      content:
        application/problem+json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Problem'
              - type: object
                properties:
                  code:
                    enum:
                      - organization_archived
                      - plan_required
          examples:
            plan_required:
              summary: O plano gratuito não inclui a API
              value:
                type: about:blank
                title: Forbidden
                status: 403
                detail: >-
                  O plano gratuito não inclui a API. Assine um plano pago no QX
                  para usar a API.
                code: plan_required
    TooManyRequests:
      description: A chave ou o endereço IP passou de um limite.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/problem+json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Problem'
              - type: object
                properties:
                  code:
                    enum:
                      - rate_limited
                      - daily_limit_reached
                      - too_many_invalid_keys
          examples:
            rate_limited:
              summary: A chave passou do limite por minuto
              value:
                type: about:blank
                title: Too Many Requests
                status: 429
                detail: >-
                  A chave passou de um limite por minuto. Espere os segundos do
                  cabeçalho Retry-After e chame de novo.
                code: rate_limited
  examples:
    IdempotencyKeyInUse:
      summary: Outra chamada com o mesmo Idempotency-Key está em curso
      value:
        type: about:blank
        title: Conflict
        status: 409
        detail: >-
          Outra chamada com este Idempotency-Key ainda está em curso. Espere
          essa chamada terminar e chame de novo.
        code: idempotency_key_in_use
    IdempotencyKeyReused:
      summary: O Idempotency-Key já atendeu outra chamada
      value:
        type: about:blank
        title: Unprocessable Content
        status: 422
        detail: >-
          Este Idempotency-Key já atendeu uma chamada com outro conteúdo. Use um
          valor novo para a chamada nova.
        code: idempotency_key_reused
  headers:
    WwwAuthenticate:
      description: O esquema de autenticação que a API espera.
      required: true
      schema:
        type: string
      example: Bearer realm="QX API"
    RetryAfter:
      description: Os segundos de espera antes da próxima chamada.
      required: true
      schema:
        type: integer
        minimum: 1
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A chave de API da organização, no cabeçalho `Authorization: Bearer
        <chave>`. A chave começa com `qx_`.

````