8.1. Usuários
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.
| Key | Value |
|---|---|
| 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 Criar Usuário
/v3/users
Cria um novo usuário na plataforma com perfil, tipo de acesso e vínculos organizacionais definidos.
Parâmetros do Body
Visualizar Parâmetros
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome completo do usuário |
accessId | string | Sim | Login de acesso do usuário |
status | number | Sim | Status do usuário (1 = ativo) |
password | string | Sim | Senha de acesso |
personType | number | Sim | Tipo de pessoa (1 = Física, 2 = Jurídica) |
identityType | number | Sim | Tipo de documento (1 = CPF) |
identity | string | Sim | Número do documento |
type | number | Sim | Tipo do usuário |
profileId | string (UUID) | Sim | ID do perfil de permissões |
accessType | number | Sim | Tipo de acesso |
email | string | Sim | E-mail do usuário |
phone | string | Sim | Telefone com DDD |
createBroker | boolean | Não | true para criar automaticamente um agente vinculado |
referenceCode | string | null | Não | Código de referência externo |
accountId | string | null | Não | ID da conta vinculada |
partnerId | string | null | Não | ID do parceiro vinculado |
storeId | string | null | Não | ID da loja vinculada |
brokerId | string | null | Não | ID do agente vinculado |
Exemplo de Requisição e Resposta
- Body
- cURL
- 200 - Sucesso
- 400 - Erro
Visualizar Body
{
"name": "Abapurasso teste",
"accessId": "abapurasso.teste",
"status": 1,
"password": "123456789",
"description": "",
"personType": 1,
"identityType": 1,
"identity": "39200709095",
"type": 1,
"profileId": "",
"accessType": 3,
"email": "[email protected]",
"phone": "11999999999",
"referenceCode": null,
"settingPackId": null,
"accountId": null,
"partnerId": null,
"storeId": null,
"brokerId": null,
"createBroker": true
}
Visualizar cURL
curl --location 'https://integration.ajin.io/v3/users' \
--header 'apikey: {{apikey}}' \
--header 'Content-Type: application/json' \
--data '{
"name": "Abapurasso teste",
"accessId": "abapurasso.teste",
"status": 1,
"password": "123456789",
"description": "",
"personType": 1,
"identityType": 1,
"identity": "39200709095",
"type": 1,
"profileId": "",
"accessType": 3,
"email": "[email protected]",
"phone": "11999999999",
"referenceCode": null,
"settingPackId": null,
"accountId": null,
"partnerId": null,
"storeId": null,
"brokerId": null,
"createBroker": true
}'
Visualizar Response
{
"id": "d1caf164-806e-4a93-8bc7-76226239170e",
"nid": 179619,
"code": 121,
"name": "Abapurasso Teste",
"firstName": "Abapurasso",
"lastName": "Teste",
"description": "",
"personType": {
"code": 1,
"name": "Pessoa Física"
},
"identityType": {
"code": 1,
"name": "CPF"
},
"identity": "39200709095",
"type": {
"code": 1,
"name": "Usuário"
},
"profile": {
"id": "00000000-0000-0000-0000-000000000000",
"code": 0,
"name": null
},
"accessType": {
"code": 3,
"name": "Por Perfil de Acesso"
},
"status": {
"code": 2,
"key": null,
"name": "Desativado",
"date": "2026-02-23 16:41",
"color": "#9E9E9E",
"note": null
},
"accessId": "abapurasso.teste",
"authKey": null,
"apiKey": null,
"email": "[email protected]",
"phone": "11999999999",
"authFactors": [],
"timeZone": null,
"language": {
"id": "4e1eb221-2c1f-45cf-9cbd-f1a50b5703d3",
"code": 2,
"name": "Portuguese (Brazil)"
},
"start": null,
"end": null,
"calendar": {
"id": "00000000-0000-0000-0000-000000000000",
"code": 0,
"name": null
},
"calendars": [],
"addresses": [],
"phones": [],
"emails": [],
"documents": [],
"relationships": [
{
"id": "00000000-0000-0000-0000-000000000000",
"code": 85,
"name": "Abapurasso Teste",
"description": "Agente",
"type": {
"key": "default",
"label": "Padrão"
},
"feature": {
"code": 1008,
"name": "Agente"
},
"key": "broker",
"icon": null,
"avatar": null,
"image": null,
"note": null,
"required": false,
"settings": []
}
],
"fields": [],
"tags": [],
"lastPosition": {
"latitude": null,
"longitude": null,
"accuracy": null,
"altitudeAccuracy": null,
"altitude": null,
"speed": null,
"heading": null,
"timestamp": null
},
"accessFailed": 0,
"accessCount": 0,
"lastAccess": null,
"alerts": [],
"licenseRequired": false,
"licenseId": "00000000-0000-0000-0000-000000000000",
"licenseStart": null,
"licenseEnd": null,
"licenseStatusCode": 0,
"restrictionId": "00000000-0000-0000-0000-000000000000",
"limitDate": null,
"lastIp": null,
"icon": null,
"avatar": null,
"image": null,
"color": null,
"authVersion": 4,
"referenceCode": null,
"externalCode": null,
"note": null,
"groups": [],
"formalizationStatus": {
"code": 0,
"key": null,
"name": "Nenhum",
"date": "2026-02-23 16:41",
"color": "#9E9E9E",
"note": null
},
"hierarchies": [],
"settingPack": {
"id": "00000000-0000-0000-0000-000000000000",
"code": 0,
"name": null
},
"account": {
"id": "4581ad52-2dac-4df1-b36a-3b39649407ae",
"code": 748401111,
"name": "AjinSoft"
},
"partner": {
"id": "00000000-0000-0000-0000-000000000000",
"code": 0,
"name": null
},
"store": {
"id": "00000000-0000-0000-0000-000000000000",
"code": 0,
"name": null
},
"broker": {
"id": "ef8fa6c9-81de-4e84-80ae-beddf1d27467",
"code": 85,
"name": "Abapurasso Teste"
},
"owner": {
"account": {
"id": "00000000-0000-0000-0000-000000000000",
"nid": 100001,
"name": "AjinSoft"
},
"partner": {
"id": "00000000-0000-0000-0000-000000000000",
"nid": 0,
"name": null
},
"store": {
"id": "00000000-0000-0000-0000-000000000000",
"nid": 0,
"name": null
},
"broker": {
"id": "00000000-0000-0000-0000-000000000000",
"nid": 0,
"name": null
},
"user": {
"id": "00000000-0000-0000-0000-000000000000",
"nid": 0,
"name": null
}
},
"log": {
"creationDate": "2026-02-23 16:41",
"creationUser": {
"id": "637d5cde-c346-4788-ad07-84cb68d43e64",
"code": 96,
"name": "Gustavo Torres"
},
"changeDate": "2026-02-23 16:41",
"changeUser": {
"id": "637d5cde-c346-4788-ad07-84cb68d43e64",
"code": 96,
"name": "Gustavo Torres"
},
"versionId": "4743e5ae-4a55-4afb-aea6-688b9b6abf8e",
"previousId": "5e25c923-7ec3-4a8a-8694-993bb273f33b",
"versionDate": "2026-02-23 16:41"
}
}
Visualizar Response
{
"messages": [
{
"code": "4002007",
"text": "Usuário não disponível"
}
]
}