Pular para o conteúdo principal

8.2. Contas

Autenticação​

Para realizar requisições aos nossos endpoints, é necessário utilizar uma API Key válida. Esta chave é o identificador que garante a segurança e o controle de acesso às operações da plataforma.

KeyValue
apikey{{apikey}}
aviso

Importante: Mantenha sua API Key em segurança. Ela é pessoal, intransferível e dá acesso direto às operações de crédito e dados de clientes da sua conta.


POST Cadastrar Conta​

/v3/accounts

Cadastra uma nova conta na plataforma, podendo ser pessoa física ou jurídica.

Parâmetros do Body​

Visualizar Parâmetros
CampoTipoObrigatórioDescrição
namestringSimNome da conta
nicknamestringNãoNome fantasia ou apelido
descriptionstringNãoDescrição da conta
personTypenumberSimTipo de pessoa (1 = Física, 2 = Jurídica)
identityTypenumberSimTipo de documento (4 = CNPJ)
identitystringSimNúmero do documento
birthDatestring | nullNãoData de nascimento ou fundação
referenceCodestringNãoCódigo de referência externo
notestringNãoObservações adicionais

Exemplo de Requisição e Resposta​

Visualizar Body
{ 
"name": "Abapurasso Teste",
"nickname": "Abapuru",
"description": "descrição teste",
"personType": 2,
"identityType": 4,
"identity": "26.068.020/0001-98",
"birthDate": "2005-08-11",
"referenceCode": "string",
"note": "string"
}

GET Consultar Contas​

/v3/accounts

Retorna a lista de contas cadastradas, com suporte a busca por texto.

Parâmetros de Query​

ParâmetroTipoObrigatórioDescrição
searchTextstringNãoTexto para busca por nome, documento ou apelido

Exemplo de Requisição e Resposta​

Visualizar cURL
curl --location --request GET 'https://integration.ajin.io/v3/accounts?searchText=' \
--header 'apikey: {{apikey}}'