Esta API oferece um conjunto de endpoints para acesso e consulta de dados no sistema Lex, permitindo que sistemas integrados recuperem informações e realizem operações de consulta e análise. O Lex é um sistema especializado em gerenciar dados específicos para suporte a decisões e processos empresariais, e esta API visa proporcionar acesso rápido e seguro aos seus recursos, garantindo agilidade na integração e na extração de dados.
Alguns endpoints exigem que o usuário esteja consumindo o produto do parceiro solicitante para que os dados possam ser recuperados. Esse requisito garante que apenas usuários ativos no produto solicitado possam acessar ou exibir informações relevantes, mantendo a segurança e privacidade dos dados.
Exemplo: Para visualizar os dados de um usuário específico, é necessário que ele esteja consumindo o produto em questão. Por motivos de segurança, não fornecemos informações de usuários de forma pública.
Nota: A política de acesso foi implementada para proteger os dados dos usuários, garantindo que apenas usuários e parceiros autorizados tenham acesso aos dados confidenciais.
Descrição: Endpoint para consultar informações de uma grupo ecônomico por id.
Endpoint:
/data/v1/tenants/{id}Cabeçalho:
Content-Type: application/jsonAuthorization: Bearer {access_token}Parâmetros
| Parâmetro | Tipo | Obrigatório | Tamanho | Descrição |
|---|---|---|---|---|
id |
UUID |
Sim | 36 | ID único do grupo econômico. |
Resposta
200 Ok (Sucesso)
{
"id": "1234",
"name": "XPTO",
"brand": "BRAND"
}
Parâmetros de resposta
| Parâmetro | Tipo | Obrigatório | Tamanho | Descrição |
|---|---|---|---|---|
id |
UUID |
Sim | 36 | ID único que identifica o grupo econômico. |
name |
string |
Sim | 100 | Nome do grupo econômico. |
brand |
string |
Sim | 100 | Marca associada ao grupo econômico. |
401 Unauthorized (Sem autorização, ausência de token ou token incorreto)
400 BadRequest (Requisição incorreta)
{
"Error":
{
"Code": "CLA001",
"Message": ""
}
}
409 Conflict (Paramêtros incorretos)
{
"Error": {
"Code": "FLU001",
"Message": "Error validating properties",
"ErrorProperties": [
{
"PropertyName": "tenant_id",
"ErrorMessage": "tenant_id is required."
}
]
}
}
500 Internal Server Error (Erro não mapeado no servidor)
{
"Error":
{
"Code": "INT500",
"Message": "Internal server error."
}
}
Descrição: Endpoint de consulta de uma escola pelo ID da escola.
Endpoint:
/data/v1/schools/{id}Cabeçalho:
Content-Type: application/jsonAuthorization: Bearer {access_token}Parâmetros
| Parâmetro | Tipo | Obrigatório | Tamanho | Descrição |
|---|---|---|---|---|
id |
UUID |
Sim | 36 | ID único da escola na LEX. |
Resposta
200 Ok (Sucesso)
{
"id": "d271c9d2-41e3-4a9e-9f36-5a2d6f10e5c3",
"external_id": "SCHOOL001",
"tenant_id": "a73c9c34-890f-4d1a-bcfa-67c9e2035e22",
"trade_name": "Escola Exemplo",
"company_name": "Escola Exemplo LTDA",
"document": {
"document_type": "CNPJ",
"document_value": "12.345.678/0001-99"
},
"addresses": [
{
"street": "Rua Principal",
"number": "123",
"neighborhood": "Centro",
"city": "Cidade Exemplo",
"state": "EX",
"postal_code": "12345-678"
}
]
}
Parâmetros de resposta
| Parâmetro | Tipo | Obrigatório | Tamanho | Descrição |
|---|---|---|---|---|
id |
UUID |
Sim | 36 | ID único da escola no sistema interno. |
external_id |
string |
Sim | 50 | ID único da escola no sistema parceiro. |
tenant_id |
UUID |
Sim | 36 | ID único do tenant ao qual a escola pertence. |
trade_name |
string |
Sim | 50 | Nome fantasia da escola. |
company_name |
string |
Sim | 50 | Razão social da escola. |
document |
object<document> |
Não | - | Objeto contendo o tipo e valor do documento da escola. |
addresses |
array<address> |
Não | - | Lista de endereços da escola. |
Objeto document
| Parâmetro | Tipo | Obrigatório | Tamanho | Descrição |
|---|---|---|---|---|
document_type |
string |
Sim | 20 | Tipo de documento, ex.: “CNPJ”. |
document_value |
string |
Sim | 50 | Número do documento da escola. |
Objeto address
| Parâmetro | Tipo | Obrigatório | Tamanho | Descrição |
|---|---|---|---|---|
street |
string |
Sim | 100 | Nome da rua do endereço da escola. |
number |
string |
Sim | 10 | Número do endereço. |
neighborhood |
string |
Sim | 50 | Bairro do endereço. |
city |
string |
Sim | 50 | Cidade do endereço. |
state |
string |
Sim | 50 | Estado do endereço. |
postal_code |
string |
Sim | 10 | Código postal (CEP) do endereço. |
401 Unauthorized (Sem autorização, ausência de token ou token incorreto)
400 BadRequest (Requisição incorreta)
{
"Error":
{
"Code": "CLA001",
"Message": ""
}
}
409 Conflict (Paramêtros incorretos)
{
"Error": {
"Code": "FLU001",
"Message": "Error validating properties",
"ErrorProperties": [
{
"PropertyName": "tenant_id",
"ErrorMessage": "tenant_id is required."
}
]
}
}
500 Internal Server Error (Erro não mapeado no servidor)
{
"Error":
{
"Code": "INT500",
"Message": "Internal server error."
}
}
Descrição: Endpoint de consulta dos perfis disponíveis na LEX.
Perfis Suportados:
SchoolAdmin | Manager | Secretary | Marketing | FinancialOperator | Coordinator | Assistant | Operator | Student | Nutritionist | Reviewer | Commercial | Sponsor | OperationAdmin | Teacher | Nurse
Endpoint:
/data/v1/profilesCabeçalho:
Content-Type: application/jsonAuthorization: Bearer {access_token}Resposta
200 Ok (Sucesso)
[
{
"id": "00000000-0000-0000-0000-000000000000",
"code": 8,
"name": "Admin Escola",
"type": "SchoolAdmin",
"description": "Administrador de Escola."
},
{
"id": "06FD2708-609F-4994-A8C9-269A746BA17E",
"code": 3,
"name": "Gestor",
"type": "Manager",
"description": "Diretor de escola."
}
]
Parâmetros de resposta
| Parâmetro | Tipo | Obrigatório | Tamanho | Descrição |
|---|---|---|---|---|
id |
UUID |
Sim | 36 | ID único do perfil. |
code |
int |
Sim | - | Código numérico identificador do perfil. |
name |
string |
Sim | 64 | Nome do perfil, ex.: “Admin Escola”. |
type |
string |
Sim | 50 | Tipo de perfil, ex.: “Manager”. |
description |
string |
Não | 512 | Descrição do perfil, explicando suas permissões e funções. |
401 Unauthorized (Sem autorização, ausência de token ou token incorreto)
400 BadRequest (Requisição incorreta)
{
"Error":
{
"Code": "CLA001",
"Message": ""
}
}
409 Conflict (Paramêtros incorretos)
{
"Error": {
"Code": "FLU001",
"Message": "Error validating properties",
"ErrorProperties": [
{
"PropertyName": "tenant_id",
"ErrorMessage": "tenant_id is required."
}
]
}
}
500 Internal Server Error (Erro não mapeado no servidor)
{
"Error":
{
"Code": "INT500",
"Message": "Internal server error."
}
}
Descrição: Endpoint de consulta de dependentes do usuário na LEX por account_id.
Endpoint:
/data/v1/accounts/{id}/dependentsCabeçalho:
Content-Type: application/jsonAuthorization: Bearer {access_token}Parâmetros
| Parâmetro | Tipo | Obrigatório | Tamanho | Descrição |
|---|---|---|---|---|
id |
UUID |
Sim | 36 | Account ID do responsável. |
Resposta
200 Ok (Sucesso)
[
{
"id": "1234567890abcdef",
"name": "João Silva",
"email": "joao.silva@example.com",
"document_type": "CPF",
"document": "123.456.789-00",
"schools": [
"a1b2c3d4-e5f6-7a89-b012-3456789abcdef",
"123e4567-e89b-12d3-a456-426614174000"
],
"date_of_birth": "2005-06-15T00:00:00Z"
},
{
"id": "abcdef1234567890",
"name": "Maria Oliveira",
"email": "maria.oliveira@example.com",
"document_type": "RG",
"document": "MG-12.345.678",
"schools": [
"98765432-1abc-456d-8ef0-123456789abc"
],
"date_of_birth": "2008-11-23T00:00:00Z"
}
]
Parâmetros de resposta
| Parâmetro | Tipo | Obrigatório | Tamanho | Descrição |
|---|---|---|---|---|
id |
UUID |
Sim | 36 | ID único do dependente. |
name |
string |
Sim | 150 | Nome completo do dependente. |
email |
string |
Sim | 200 | Endereço de e-mail do dependente. |
document_type |
string |
Não | 20 | Tipo de documento do dependente, ex.: “CPF” ou “RG”. |
document |
string |
Não | 50 | Número do documento do dependente. |
schools |
array<UUID> |
Não | - | Lista de IDs das escolas associadas ao dependente. |
date_of_birth |
datetime |
Sim | - | Data de nascimento do dependente. |
401 Unauthorized (Sem autorização, ausência de token ou token incorreto)
400 BadRequest (Requisição incorreta)
{
"Error":
{
"Code": "CLA001",
"Message": ""
}
}
409 Conflict (Paramêtros incorretos)
{
"Error": {
"Code": "FLU001",
"Message": "Error validating properties",
"ErrorProperties": [
{
"PropertyName": "tenant_id",
"ErrorMessage": "tenant_id is required."
}
]
}
}
500 Internal Server Error (Erro não mapeado no servidor)
{
"Error":
{
"Code": "INT500",
"Message": "Internal server error."
}
}
Descrição: Endpoint de consulta de usuário na LEX por account_id.
Endpoint:
/data/v1/accounts/{account_id}Cabeçalho:
Content-Type: application/jsonAuthorization: Bearer {access_token}Parâmetros
| Parâmetro | Tipo | Obrigatório | Tamanho | Descrição |
|---|---|---|---|---|
account_id |
UUID |
Sim | 36 | Account ID para identificar o usuário. |
Resposta
200 Ok (Sucesso)
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Ana Souza",
"document_type": "CPF",
"document": "123.456.789-00",
"email": "ana.souza@example.com",
"phone": "+55 11 91234-5678",
"schools": [
"a1b2c3d4-e5f6-7a89-b012-3456789abcdef",
"98765432-1abc-456d-8ef0-123456789abc"
],
"date_of_birth": "1995-05-20T00:00:00Z"
}
Parâmetros de resposta
| Parâmetro | Tipo | Obrigatório | Tamanho | Descrição |
|---|---|---|---|---|
id |
UUID |
Sim | 36 | ID único do usuário. |
name |
string |
Sim | 150 | Nome completo do usuário. |
document_type |
string |
Sim | 20 | Tipo de documento, ex.: “CPF” ou “RG”. |
document |
string |
Sim | 50 | Número do documento do usuário. |
email |
string |
Sim | 200 | Endereço de e-mail do usuário. |
phone |
string |
Não | 11 | Número de telefone do usuário com DDI e DDD. |
schools |
array de UUID |
Não | - | Lista de IDs das escolas associadas ao usuário. |
date_of_birth |
datetime |
Sim | - | Data de nascimento do usuário, formato ISO 8601. |
401 Unauthorized (Sem autorização, ausência de token ou token incorreto)
400 BadRequest (Requisição incorreta)
{
"Error":
{
"Code": "CLA001",
"Message": ""
}
}
409 Conflict (Paramêtros incorretos)
{
"Error": {
"Code": "FLU001",
"Message": "Error validating properties",
"ErrorProperties": [
{
"PropertyName": "tenant_id",
"ErrorMessage": "tenant_id is required."
}
]
}
}
500 Internal Server Error (Erro não mapeado no servidor)
{
"Error":
{
"Code": "INT500",
"Message": "Internal server error."
}
}
Descrição: Endpoint de consulta do usuário na LEX por account_id e IDs (school_external_id,school_id) das escolas.
Endpoint:
/data/partner/v1/accounts/{AccountId}?school_id={school_id}&school_external_id={school_external_id}Cabeçalho:
Content-Type: application/jsonAuthorization: Bearer {access_token}Parâmetros
| Parâmetro | Tipo | Obrigatório | Tamanho | Descrição |
|---|---|---|---|---|
accountId |
UUID |
Sim | 36 | Account ID para identificar o usuário. |
school_external_id |
string |
Não | 50 | Identificador da escola no sistema parceiro. |
school_id |
UUID |
Não | 36 | Identificador único da escola na LEX. |
É necessário ou um
school_external_idou umschool_id
Resposta
200 Ok (Sucesso)
{
"account_id": "a12b3c4d-5e6f-7g8h-9i10-jk11l12m13n14",
"external_id": "user-external-id-12345",
"first_name": "John",
"last_name": "Doe",
"birth_date": "1990-01-01T00:00:00",
"school_external_id": "school-external-id-123",
"document_type": "CPF",
"document_value": "12345678900",
"ddi": "+55",
"cell_phone": "11987654321",
"email": "john.doe@example.com",
"academic_email": "john.doe@university.edu",
"profiles": ["Student", "Alumni"],
"responsible_external_id": ["responsible-external-id-1", "responsible-external-id-2"],
"status": true
}
Parâmetros de resposta
| Parâmetro | Tipo | Obrigatório | Tamanho | Descrição |
|---|---|---|---|---|
account_id |
UUID |
Sim | 36 | ID único que identifica o aluno na LEX. |
school_external_id |
string |
Sim | 50 | ID único que identifica a escola no sistema parceiro. |
external_id |
string |
Sim | 50 | ID único que identifica a pessoa no sistema parceiro. |
first_name |
string |
Sim | 50 | Primeiro nome da pessoa. |
last_name |
string |
Sim | 100 | Sobrenome(s) da pessoa. |
birth_date |
datetime |
Sim | - | Data de nascimento da pessoa. |
document_type |
string |
Não (para perfil student) | 20 | Tipo de documento, ex.: “CPF”. |
document_value |
string |
Não (para perfil student) | 20 | Número do documento, caso aplicável. |
ddi |
int |
Não (para perfil student) | 5 | Código DDI (discagem direta internacional) do telefone. |
cell_phone |
string |
Não (para perfil student) | 11 | Número de telefone celular. |
email |
string |
Não (para perfil student) | 200 | Endereço de e-mail. |
academic_email |
string |
Não | 200 | Endereço de e-mail acadêmico. |
profiles |
array |
Sim | - | Lista de perfis associados ao usuário. Ex.: [“student”]. |
responsible_external_id |
array |
Não (para perfil student) | 50 | IDs dos responsáveis associados ao usuário, caso aplicável. |
status |
boolean |
sim | - | Indica o status do cadastro do usuário. |
401 Unauthorized (Sem autorização, ausência de token ou token incorreto)
400 BadRequest (Requisição incorreta)
{
"Error":
{
"Code": "CLA001",
"Message": ""
}
}
409 Conflict (Paramêtros incorretos)
{
"Error": {
"Code": "FLU001",
"Message": "Error validating properties",
"ErrorProperties": [
{
"PropertyName": "tenant_id",
"ErrorMessage": "tenant_id is required."
}
]
}
}
500 Internal Server Error (Erro não mapeado no servidor)
{
"Error":
{
"Code": "INT500",
"Message": "Internal server error."
}
}
Descrição: Endpoint de consulta dos turnos de uma escola através do school_external_id.
Endpoint:
/data/v1/educational-shifts?school_external_id={school_external_id}Cabeçalho:
Content-Type: application/jsonAuthorization: Bearer {access_token}Parâmetros
| Parâmetro | Tipo | Obrigatório | Tamanho | Descrição |
|---|---|---|---|---|
school_external_id |
string |
Não | 50 | Identificador da escola no sistema parceiro. |
Resposta
200 Ok (Sucesso)
[
{
"name": "Manhã",
"description": "Matutino"
},
{
"name": "Noite",
"description": "Noturno"
}
]
Parâmetros de resposta
| Parâmetro | Tipo | Obrigatório | Tamanho | Descrição |
|---|---|---|---|---|
name |
string |
Sim | 80 | Nome para identificar a turno. |
description |
string |
Sim | 200 | Descrição do turno. |
401 Unauthorized (Sem autorização, ausência de token ou token incorreto)
400 BadRequest (Requisição incorreta)
{
"Error":
{
"Code": "CLA001",
"Message": ""
}
}
409 Conflict (Paramêtros incorretos)
{
"Error": {
"Code": "FLU001",
"Message": "Error validating properties",
"ErrorProperties": [
{
"PropertyName": "tenant_id",
"ErrorMessage": "tenant_id is required."
}
]
}
}
500 Internal Server Error (Erro não mapeado no servidor)
{
"Error":
{
"Code": "INT500",
"Message": "Internal server error."
}
}
Descrição: Endpoint de consulta dos séries de uma escola através do school_external_id.
Endpoint:
/data/v1/educational-stages?school_external_id={school_external_id}Cabeçalho:
Content-Type: application/jsonAuthorization: Bearer {access_token}Parâmetros
| Parâmetro | Tipo | Obrigatório | Tamanho | Descrição |
|---|---|---|---|---|
school_external_id |
string |
Não | 50 | Identificador da escola no sistema parceiro. |
Resposta
200 Ok (Sucesso)
[
{
"name": "EI5",
"description": "EDUCAÇÃO INFANTIL 05 ANOS"
},
{
"name": "EF6",
"description": "FUNDAMENTAL 02 - 6º ANO"
}
]
Parâmetros de resposta
| Parâmetro | Tipo | Obrigatório | Tamanho | Descrição |
|---|---|---|---|---|
name |
string |
Sim | 80 | Nome para identificar a série. |
description |
string |
Sim | 200 | Descrição da série. |
401 Unauthorized (Sem autorização, ausência de token ou token incorreto)
400 BadRequest (Requisição incorreta)
{
"Error":
{
"Code": "CLA001",
"Message": ""
}
}
409 Conflict (Paramêtros incorretos)
{
"Error": {
"Code": "FLU001",
"Message": "Error validating properties",
"ErrorProperties": [
{
"PropertyName": "tenant_id",
"ErrorMessage": "tenant_id is required."
}
]
}
}
500 Internal Server Error (Erro não mapeado no servidor)
{
"Error":
{
"Code": "INT500",
"Message": "Internal server error."
}
}
Descrição: Endpoint de consulta das escolas ativas na LEX que contenha determinada integração.
Endpoint:
/data/partner/v1/schools?external_integration_id={external_integration_id}Cabeçalho:
Content-Type: application/jsonAuthorization: Bearer {access_token}Parâmetros
| Parâmetro | Tipo | Obrigatório | Tamanho | Descrição |
|---|---|---|---|---|
external_integration_id |
string |
Não | 50 | ID da integração do sistema parceiro. |
Resposta
200 Ok (Sucesso)
{
"data": [
{
"school_id": "00000000-0000-0000-0000-000000000000",
"fantasy_name": "COLEGIO 123",
"external_id": "ABC123",
"tenant_id": "00000000-0000-0000-0000-000000000000",
"company_name": "TENANT 123",
"cnpj": "11.111.111/1111-11"
},
{
"school_id": "00000000-0000-0000-0000-000000000000",
"fantasy_name": "COLEGIO 123",
"external_id": "ABC123",
"tenant_id": "00000000-0000-0000-0000-000000000000",
"company_name": "TENANT 123"
}
]
}
Parâmetros de resposta
| Parâmetro | Tipo | Obrigatório | Tamanho | Descrição |
|---|---|---|---|---|
school_id |
UUID |
Sim | 36 | ID único da escola. |
fantasy_name |
string |
Sim | 64 | Nome da escola. |
external_id |
string |
Não | 50 | ID único que identifica a escola no sistema parceiro. |
tenant_id |
UUID |
Sim | 36 | ID único do Grupo Economico da Escola. |
company_name |
string |
Sim | 100 | Nome do Grupo Economico da Escola. |
cnpj |
string |
Não | 18 | Documento de registro da escola. |
401 Unauthorized (Sem autorização, ausência de token ou token incorreto)
400 BadRequest (Requisição incorreta)
{
"Error":
{
"Code": "CLA001",
"Message": ""
}
}
409 Conflict (Paramêtros incorretos)
{
"Error": {
"Code": "FLU001",
"Message": "Error validating properties",
"ErrorProperties": [
{
"PropertyName": "tenant_id",
"ErrorMessage": "tenant_id is required."
}
]
}
}
500 Internal Server Error (Erro não mapeado no servidor)
{
"Error":
{
"Code": "INT500",
"Message": "Internal server error."
}
}
Descrição: Obter a lista de turmas ativas e inativas de uma escola atraves do id externo.
Endpoint:
/data/partner/v1/classes?school_external_id={school_external_id}Cabeçalho:
Content-Type: application/jsonAuthorization: Bearer {access_token}Resposta
200 Ok (Sucesso)
{
"data": [
{
"external_id": "1234567y-cc80-4302-a4c3-5fb7b1817f04",
"educational_stage": "ENSINO FUNDAMENTAL II",
"grade": "FUNDAMENTAL 02 - 8º ANO",
"name": "Turma XPTO",
"class_id": "1234567y-9704-4883-b810-44eb3c425703",
"status": "Open",
"shift": "Integral"
},
{
"external_id": "1234567y-cc80-4302-b4c3-5fb7b1817f04",
"educational_stage": "ENSINO FUNDAMENTAL II",
"grade": "FUNDAMENTAL 02 - 8º ANO",
"name": "Turma XPTO",
"class_id": "1234567y-e4d6-4660-97d5-45fb5973719f",
"status": "Closed"
}
]
}
Parametros de Resposta
| Parâmetro | Tipo | Obrigatório | Tamanho | Descrição |
|---|---|---|---|---|
external_id |
string |
Sim | 50 | ID único da escola. |
educational_stage |
string |
Sim | 200 | Nível educacional da classe. |
grade |
string |
Sim | 200 | Série. |
name |
string |
Sim | 100 | Nome da escola. |
class_id |
UUID |
Sim | 36 | Id da Turma na LEX. |
status |
string |
Sim | 15 | Status da turma. |
shift |
string |
No | 80 | Turno escolar. |
401 Unauthorized (Sem autorização, ausência de token ou token incorreto)
400 BadRequest (Requisição incorreta)
{
"Error":
{
"Code": "CLA001",
"Message": ""
}
}
409 Conflict (Paramêtros incorretos)
{
"Error": {
"Code": "FLU001",
"Message": "Error validating properties",
"ErrorProperties": [
{
"PropertyName": "tenant_id",
"ErrorMessage": "tenant_id is required."
}
]
}
}
500 Internal Server Error (Erro não mapeado no servidor)
{
"Error":
{
"Code": "INT500",
"Message": "Internal server error."
}
}
Descrição: Endpoint para consultar usuários de uma escola através do ID externo da escola.
Endpoint:
/data/partner/v1/user?schoolExternalId={school_external_id}Cabeçalho:
Content-Type: application/jsonAuthorization: Bearer {access_token}Parametros
| Parâmetro | Tipo | Obrigatório | Tamanho | Descrição |
|---|---|---|---|---|
school_external_id |
string |
Sim | 50 | Identificador único da escola no sistema do parceiro. |
Resposta
200 Ok (Sucesso)
{
"data": [
{
"id": "1234567y-4049-4c9b-ae92-0045c35adbe3",
"name": "Responsável XPTO",
"external_id": "080820300",
"birth_date": "2000-01-01T00:00:00Z",
"email": "teste@teste.com.br",
"cell_phone_number": "",
"tenant_id": "1234567y-821a-487a-a767-e96c6cb885bb",
"status": "Active",
"account_id": "1234567y-cb71-408f-b889-725ce3967606",
"registration_origin": "Undefined",
"documents": [
{
"type": "CPF",
"value": "1111111111"
}
],
"profiles": [
{
"id": "f18dc123-be48-4a74-b8b9-88403eb8d123",
"name": "Student"
}
]
}
]
}
Parâmetros
| Parâmetro | Tipo | Obrigatório | Tamanho | Descrição |
|---|---|---|---|---|
id |
UUI |
Sim | 36 | Identificador único da entidade. |
name |
string |
Sim | 100 | Nome completo da pessoa ou responsável. |
external_id |
string |
Não | 50 | Identificador de referência externa. |
birth_date |
string |
Sim | 10 | Data de nascimento no formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ). |
email |
string |
Sim | 200 | Endereço de e-mail válido do usuário. |
cell_phone_number |
string |
Não | 20 | Número de celular no formato nacional. |
tenant_id |
string |
Sim | 36 | Identificador do inquilino (tenant). |
status |
string |
Sim | 20 | Estado atual da conta (e.g., “Active”). |
account_id |
UUID |
Sim | 36 | Identificador único da conta associada. |
ddi |
string |
Não | 4 | Código DDI do país. |
registration_origin |
string |
Sim | 20 | Origem do registro, indicando como o cadastro foi feito (e.g., “Lex”). |
documents |
Document[] |
Sim | - | Lista de documentos). |
profiles |
Profile[] |
Sim | - | Lista de perfis). |
| Parâmetro | Tipo | Obrigatório | Tamanho | Descrição |
|---|---|---|---|---|
type |
string |
Sim | 10 | Tipo de documento cadastrado (e.g., “CPF”). |
value |
string |
Sim | 50 | Valor do documento, sem espaços desnecessários. |
| Parâmetro | Tipo | Obrigatório | Tamanho | Descrição |
|---|---|---|---|---|
id |
UUID |
Sim | 36 | Identificador do perfil. |
name |
string |
Sim | 50 | Nome do perfil. |
401 Unauthorized (Sem autorização, ausência de token ou token incorreto)
400 BadRequest (Requisição incorreta)
{
"Error":
{
"Code": "CLA001",
"Message": ""
}
}
409 Conflict (Paramêtros incorretos)
{
"Error": {
"Code": "FLU001",
"Message": "Error validating properties",
"ErrorProperties": [
{
"PropertyName": "tenant_id",
"ErrorMessage": "tenant_id is required."
}
]
}
}
500 Internal Server Error (Erro não mapeado no servidor)
{
"Error":
{
"Code": "INT500",
"Message": "Internal server error."
}
}