Create person with the Conta Azul API

Creates a person, which is a customer, a supplier or a carrier according to perfis. nome and tipo_pessoa are required; send cpf for an individual and cnpj for a company. The response has the id of the person.

Identifier
conta_azul_create_person

The request

POST https://connect.reportei.com/api/tools/conta_azul_create_person/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "nome": "<nome>",
    "tipo_pessoa": "Física"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
nomestringYesName of the person or legal name of the company.
tipo_pessoastringYesFísica (individual), Jurídica (company) or Estrangeira (foreign).Values: Física, Jurídica, Estrangeira
perfisarrayNoProfiles of the person, for example one item with tipo_perfil Cliente for a customer.
cpfstringNoCPF of an individual, for example 123.456.789-00.
cnpjstringNoCNPJ of a company, for example 12.345.678/0001-90.
nome_fantasiastringNoTrade name of a company.
emailstringNoEmail addresses of the person, separated by commas.
telefone_celularstringNoCell phone with area code, digits only, for example 11987654321.
telefone_comercialstringNoBusiness phone with area code, digits only.
codigostringNoCode of the person in your own system.
observacaostringNoNotes about the person.
enderecosarrayNoAddresses of the person.

Supported connections

Your customer connects their Conta Azul account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/conta_azul, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/conta_azul_create_person. It becomes your agent's tool definition with no conversion.

Other Conta Azul tools

See all 13 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.