> ## 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. # Read a contact > Reads a person or a company of the key's organization. The call also finds an archived contact and a shareholder that the CNPJ lookup created. ## OpenAPI ````yaml /en/openapi.yaml get /contacts/{id} openapi: 3.1.0 info: title: QX API version: 1.0.0 description: >- The QX API creates and reads the contacts, the collections and the documents of the organization, and it lists the packs. Each call carries the API key of the organization. The API sends each error in the RFC 9457 format (`application/problem+json`), with a stable `code`. In addition to the errors of each endpoint, any path under `/api/v1` can return these errors: - `404` with `route_not_found`: the API does not have the path, or the path does not accept the HTTP method. - `405` with `method_not_allowed`: the API does not recognize the HTTP method. - `406` with `not_acceptable`: the API does not recognize the `Content-Type` or the `Accept` of the call. - another `4xx` status with `request_refused`: the API could not complete the call. - a `5xx` status with `internal_error`: QX had an internal error. servers: - url: https://app.useqx.com/api/v1 description: Production security: - bearerAuth: [] tags: - name: Collections description: >- The collections of the organization. A collection asks the contact for the documents of a pack. - name: Contacts description: >- The people and the companies of the organization. A person has a CPF, and a company has a CNPJ. - name: Documents description: >- The documents of the organization. A document sent without a collection goes to Triage. A document sent with a collection fills the slot of its type. - name: Packs description: The packs of the organization and the requirements of each pack. paths: /contacts/{id}: get: tags: - Contacts summary: Read a contact description: >- Reads a person or a company of the key's organization. The call also finds an archived contact and a shareholder that the CNPJ lookup created. operationId: getContact parameters: - name: id in: path required: true description: >- The id of the contact. A person id starts with `per_`, and a company id starts with `com_`. schema: type: string example: com_12 responses: '200': description: The contact. content: application/json: schema: $ref: '#/components/schemas/Contact' examples: company: summary: The company after the CNPJ lookup 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' '400': $ref: '#/components/responses/MalformedRequest' '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: >- The id of the contact. A person id starts with `per_`, and a company id starts with `com_`. examples: - com_12 type: type: string enum: - person - company description: '`person` for a person and `company` for a company.' name: type: - string - 'null' description: >- The name of the contact. The value is `null` until the CPF or CNPJ lookup returns the name. examples: - Importadora Exemplo Ltda trade_name: type: - string - 'null' description: The trade name of the company. On a person, the value is `null`. examples: - Exemplo email: type: - string - 'null' description: The email of the contact, in lowercase. examples: - fiscal@importadora.com.br tax_id: type: - string - 'null' description: >- The CPF of the person or the CNPJ of the company, without punctuation and with uppercase letters. The value is `null` on a person who waits for the CPF confirmation. examples: - '12345678000195' lookup_status: type: string enum: - not_enqueued - pending - completed - failed - stale - needs_review description: >- The progress of the CPF or CNPJ lookup. `not_enqueued`: the lookup did not start. `pending`: the lookup is in progress. `completed`: the lookup ended. `failed`: the lookup failed. `stale`: the lookup data is old. `needs_review`: the person waits for the CPF confirmation. discarded: type: boolean description: With `true`, the contact is archived. origin: type: string enum: - contact - shareholder description: >- `contact` for a contact that the organization created. `shareholder` for a shareholder that the CNPJ lookup created. created_at: type: string format: date-time description: >- The date and the time of the creation, in the time zone of the organization. examples: - '2026-09-25T10:30:00.000-03:00' Problem: type: object description: An error in the RFC 9457 format. required: - type - title - status - detail - code properties: type: type: string const: about:blank description: Always `about:blank`. title: type: string description: The phrase of the HTTP status, in English. examples: - Unauthorized status: type: integer description: The HTTP status. examples: - 401 detail: type: string description: >- The explanation of the error, in the language of the organization. An answer that leaves before the key identifies the organization stays in Portuguese. code: type: string description: >- The error code, in English. The code does not change between versions of v1. responses: MalformedRequest: description: >- The API could not read the call. Examples of causes: - the path or the query has an invalid encoding; - the query repeats a parameter in different forms, such as `limit=1&limit[]=2`; - the address in the `Client-IP` header is not in the `X-Forwarded-For` header. content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/Problem' - type: object properties: code: enum: - malformed_request examples: malformed_request: $ref: '#/components/examples/MalformedRequest' Unauthorized: description: The key is missing, does not exist or is revoked. 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: The key is missing or not valid value: type: about:blank title: Unauthorized status: 401 detail: >- The call did not include a valid API key. Send the key in the Authorization header, in the format Bearer . code: unauthorized PaymentRequired: description: The subscription of the organization is blocked. content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/Problem' - type: object properties: code: enum: - subscription_blocked examples: subscription_blocked: summary: The subscription is blocked value: type: about:blank title: Payment Required status: 402 detail: >- The subscription of the organization is blocked. Settle the payment in QX to use the API. code: subscription_blocked Forbidden: description: >- The organization is archived, or the plan of the organization does not include the API. content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/Problem' - type: object properties: code: enum: - organization_archived - plan_required examples: plan_required: summary: The free plan does not include the API value: type: about:blank title: Forbidden status: 403 detail: >- The free plan does not include the API. Subscribe to a paid plan in QX to use the API. code: plan_required NotFound: description: The resource does not exist in the key's organization. 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: The key or the IP address went over a limit. 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: The key went over the per-minute limit value: type: about:blank title: Too Many Requests status: 429 detail: >- The key went over a per-minute limit. Wait for the seconds in the Retry-After header and call again. code: rate_limited examples: MalformedRequest: summary: The API could not read the call value: type: about:blank title: Bad Request status: 400 detail: >- The API could not read the call. Check the shape and the encoding of the path and the query, the JSON of the body and the headers. code: malformed_request NotFound: summary: The id does not exist in the key's organization value: type: about:blank title: Not Found status: 404 detail: The resource does not exist in the key's organization. code: not_found headers: WwwAuthenticate: description: The authentication scheme that the API expects. required: true schema: type: string example: Bearer realm="QX API" RetryAfter: description: The seconds to wait before the next call. required: true schema: type: integer minimum: 1 securitySchemes: bearerAuth: type: http scheme: bearer description: >- The API key of the organization, in the `Authorization: Bearer ` header. The key starts with `qx_`. ````