Skip to main content
POST

Authorizations

Authorization
string
header
required

The API key of the organization, in the Authorization: Bearer <key> header. The key starts with qx_.

Headers

Idempotency-Key
string

A unique value that your system creates for each write, such as a UUID. A repeated call with the same value and the same content gets the first response, and the API writes nothing new. The API keeps the response for 24 hours.

Required string length: 1 - 255

Body

application/json
tax_id
string
required

The CPF of the person or the CNPJ of the company, with or without punctuation. A CNPJ can have letters in the first twelve positions. The value decides the type of the contact.

Example:

"12.345.678/0001-95"

email
string<email>
required

The email of the contact.

Example:

"fiscal@importadora.com.br"

name
string

The name of the contact. Without a name, the contact gets the name that the CPF or CNPJ lookup returns.

Example:

"Importadora Exemplo Ltda"

Response

The new contact.

id
string
required

The id of the contact. A person id starts with per_, and a company id starts with com_.

Pattern: ^(per|com)_[1-9][0-9]*$
Example:

"com_12"

type
enum<string>
required

person for a person and company for a company.

Available options:
person,
company
name
string | null
required

The name of the contact. The value is null until the CPF or CNPJ lookup returns the name.

Example:

"Importadora Exemplo Ltda"

trade_name
string | null
required

The trade name of the company. On a person, the value is null.

Example:

"Exemplo"

email
string | null
required

The email of the contact, in lowercase.

Example:

"fiscal@importadora.com.br"

tax_id
string | null
required

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.

Example:

"12345678000195"

lookup_status
enum<string>
required

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.

Available options:
not_enqueued,
pending,
completed,
failed,
stale,
needs_review
discarded
boolean
required

With true, the contact is archived.

origin
enum<string>
required

contact for a contact that the organization created. shareholder for a shareholder that the CNPJ lookup created.

Available options:
contact,
shareholder
created_at
string<date-time>
required

The date and the time of the creation, in the time zone of the organization.

Example:

"2026-09-25T10:30:00.000-03:00"