documentostringRequiredCarrier CPF or CNPJ, digits only. CPF is accepted: a self-employed carrier is an individual.
← HomeFleetPay / API
Invite a carrier
Parameters, data structure and responses from the versioned contract.
POST
/convites/transportadorasTechnical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.
Invites a carrier to open a FleetPay account.
You do not register the carrier — you introduce it. FleetPay handles registration directly with the legal representative: that person supplies the information only they have, completes biometric verification and finishes opening the digital account. That is why the invitation requires only two fields.
The invitation arrives via WhatsApp at the supplied number. FleetPay handles follow-up from there.
telefone is the legal representative's mobile number, not the carrier's business phone number — FleetPay will speak with this person to open the account. An incorrect number means the invitation does not reach the intended person.
The document may be a CPF or CNPJ. An individual carrier (a self-employed carrier) is a common case and is accepted here.
Repeating the request is safe. If the carrier has already been invited — even by another company — the response is 200 with status: ja_convidada, and no new invitation is sent. Only the first invitation triggers a message.
This endpoint does not open an account or enable anyone to receive payments. It starts the conversation.
Authentication
[
{
"oauth2": []
},
{
"chaveApi": []
}
]Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.
Parameters
No parameters declared for this operation.
Request Body
Required
application/json
telefonestringRequiredLEGAL REPRESENTATIVE's mobile number, including area code (10 or 11 digits). The invitation is sent here through WhatsApp. Accepted with or without the country code.
Responses
200 HTTP Response
The carrier had already been invited. No new invitation was sent. This is not an error; it is the result of calling twice.
201 HTTP Response
Invitation sent
401 HTTP Response
Unauthenticated (autenticacao): missing, invalid or expired credentials, including an API key used in the wrong environment. A sandbox key is not valid in production, nor a production key in the sandbox; the error message indicates the expected environment.
429 HTTP Response
Request limit exceeded (limite_requisicoes). Wait for the interval specified in the Retry-After header before retrying. This may be a limit forwarded from the provider or FleetPay's own anti-abuse limit, counted per authenticated company and route group, with a short window for bursts and a long window for slower automated traffic. Limits are intentionally generous: genuine integrations, including large batches processed at once, should remain well below them. If yours reaches a limit, contact FleetPay.
Complete Operation Definition
{
"tags": [
"Convites"
],
"summary": "Convidar uma transportadora",
"operationId": "convidarTransportadora",
"description": "Convida uma transportadora para abrir conta na FleetPay.\n\n**Voce nao cadastra a transportadora — voce a apresenta.** O cadastro e conduzido pela\nFleetPay junto ao representante legal: e ele quem informa os dados que so ele tem, faz a\nbiometria e conclui a abertura da conta digital. Por isso o convite pede so dois campos.\n\nO convite chega por **WhatsApp** no numero informado. A partir dai o acompanhamento e da\nFleetPay.\n\n**O `telefone` e o celular do representante legal**, nao o telefone comercial da\ntransportadora — e com essa pessoa que a FleetPay vai conversar para abrir a conta. Um\nnumero errado significa um convite que nao chega a ninguem.\n\n**O documento pode ser CPF ou CNPJ.** Transportadora pessoa fisica (o transportador\nautonomo) e caso comum e e aceita aqui.\n\n**Chamar de novo e seguro.** Se a transportadora ja foi convidada — inclusive por outra\nempresa — a resposta e `200` com `status: ja_convidada`, e nenhum convite novo e enviado.\nSo o primeiro convite dispara mensagem.\n\n> Este endpoint **nao** abre conta e **nao** habilita ninguem a receber pagamento. Ele\n> inicia a conversa.\n",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConviteTransportadoraRequest"
}
}
}
},
"responses": {
"200": {
"description": "A transportadora ja havia sido convidada. Nenhum convite novo foi enviado. Nao e erro: e o resultado de chamar duas vezes.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RespostaConvite"
}
}
}
},
"201": {
"description": "Convite enviado",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RespostaConvite"
}
}
}
},
"400": {
"$ref": "#/components/responses/Erro400"
},
"401": {
"$ref": "#/components/responses/Erro401"
},
"403": {
"$ref": "#/components/responses/Erro403"
},
"429": {
"$ref": "#/components/responses/Erro429"
},
"500": {
"$ref": "#/components/responses/Erro500"
}
},
"method": "POST",
"path": "/convites/transportadoras",
"parameters": []
}