Create partner

post

https://api.astongestao.com.br/partners/

Create a new partner with person orchestration

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

personType

string

enum

required

Allowed:

name

string

legalName

string

documentNumber

string

required

length ≥ 1

string

phone

string

stateRegistration

string

municipalRegistration

string

contributorCode

string

enum

Allowed:

address

string

addressNumber

string

addressComplement

string

neighborhood

string

city

string

state

string

zipCode

string

country

string

contacts

array of objects

contacts

relationships

array of objects

relationships

files

array of objects

files

externalCode

string | null

\S.*

Código externo opcional (SKU, ERP)

taxRegime

string | null

enum

Regime tributário do tomador (nullable = desconhecido); só pessoa jurídica

Allowed:

publicBody

boolean

Defaults to false

Indica se o tomador é órgão público

publicBodySphere

string | null

enum

Esfera do órgão público; obrigatória quando publicBody=true

Allowed:

pixKey

string | null

Chave PIX do favorecido; anda em par com pixKeyType

pixKeyType

string | null

enum

Tipo da chave PIX; obrigatório quando pixKey é informada

Allowed:

bankCode

string | null

^$|^\d{3}$

Código de compensação do banco (3 dígitos)

agency

string | null

Agência do favorecido, sem dígito

accountNumber

string | null

Número da conta do favorecido, sem dígito

accountDigit

string | null

Dígito verificador da conta

bankAccountType

string | null

enum

Tipo da conta bancária do favorecido

Allowed:

beneficiaryName

string | null

Nome do titular da conta; vazio = usa o nome do parceiro

beneficiaryDocument

string | null

CPF/CNPJ do titular da conta; vazio = usa o documento do parceiro

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200OK