Listar subcontas | Dom Docs

GET{apiUrl}/subaccount

URL base da API

Token de autenticação

Query Params

pageintegeroptional

Página buscada

limitintegeroptional

Limite de itens retornados por página (limite máximo de 100)

curl --request GET \
  --url "{apiUrl}/subaccount"

Response

Choose an example:

application/json

Campos da resposta

totalinteger

Total de subcontas encontradas

per_pageinteger

Quantidade de itens por página

pagestring

Página atual

total_pagesinteger

Total de páginas

dataarray

Lista de subcontas

data[].idstring

ID único da subconta (UUID)

data[].corporate_docstring

CNPJ da empresa

data[].corporate_namestring

Razão social da empresa

data[].namestring

Nome fantasia

data[].external_referencestring

Referência externa do integrador

data[].address.streetstring

Logradouro

data[].address.numberstring

Número

data[].address.neighborhoodstring

Bairro

data[].address.zip_codestring

CEP

data[].address.citystring

Cidade

data[].address.statestring

Estado (UF)

data[].partner_adm.namestring

Nome do sócio administrador

data[].partner_adm.docstring

CPF do sócio

data[].partner_adm.birthdatestring

Data de nascimento (YYYY-MM-DD)

data[].partner_adm.emailstring

E-mail do sócio

data[].partner_adm.phonestring

Telefone do sócio

data[].support.phonestring

Telefone de suporte

data[].support.emailstring

E-mail de suporte

data[].support.sitestring

Site de suporte

data[].financial_pixout.keystring

Chave Pix de saída financeira

data[].financial_pixout.typestring

Tipo da chave: CNPJ, CPF, EMAIL, PHONE ou EVP

data[].statusstring

Status da subconta: APPROVED, pending, rejected, blocked ou CANCELLED

data[].msgstring

Mensagem de retorno

data[].credentials.public_keystring

Chave pública da subconta

data[].credentials.tokenstring

Token mascarado

data[].created_atstring

Data de criação (ISO 8601)

data[].updated_atstring

Data de atualização (ISO 8601)