> ## 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. # Ler um contato > Lê uma pessoa ou uma empresa da organização da chave. A chamada acha também o contato arquivado e o sócio que a consulta do CNPJ criou. ## OpenAPI ````yaml /openapi.yaml get /contacts/{id} 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/{id}: get: tags: - Contatos summary: Ler um contato description: >- Lê uma pessoa ou uma empresa da organização da chave. A chamada acha também o contato arquivado e o sócio que a consulta do CNPJ criou. operationId: getContact parameters: - name: id in: path required: true description: >- O id do contato. O id da pessoa começa com `per_`, e o id da empresa começa com `com_`. schema: type: string example: com_12 responses: '200': description: O contato. content: application/json: schema: $ref: '#/components/schemas/Contact' examples: company: summary: A empresa depois da consulta do CNPJ value: 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' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/PaymentRequired' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' components: schemas: 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' 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. responses: 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 . 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 NotFound: description: O recurso não existe na organização da chave. content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/Problem' - type: object properties: code: enum: - not_found examples: not_found: $ref: '#/components/examples/NotFound' 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 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 examples: NotFound: summary: O id não existe na organização da chave value: type: about:blank title: Not Found status: 404 detail: O recurso não existe na organização da chave. code: not_found securitySchemes: bearerAuth: type: http scheme: bearer description: >- A chave de API da organização, no cabeçalho `Authorization: Bearer `. A chave começa com `qx_`. ````