1. Introdução Geral
Este documento reúne as especificações técnicas das APIs de Cadastro de Pessoas Físicas e Cadastro de Empresas (CNPJ) da Liberado App. Ele é destinado a clientes que desejam integrar seus sistemas com as funcionalidades oferecidas pela plataforma, permitindo a consulta de dados e verificações de antecedentes de pessoas físicas e jurídicas. As seções a seguir detalham os endpoints, autenticação, parâmetros, exemplos de requisições e respostas, além de observações importantes, mantendo a separação clara entre as APIs de Pessoa Física e Empresa/CNPJ.
2. API Pessoa Física
2.1 Endpoints
POST /basic-person
Endpoint responsável por adicionar uma nova pessoa somente com os seus dados pessoais.
OBS: O CPF é a única propriedade obrigatória.
GET /basic-person/{cpf}
Endpoint responsável por consultar os dados da pessoa cadastrada pelo CPF.
POST /advanced-person
Endpoint responsável por adicionar uma nova pessoa usando a sua foto selfie e os seus documentos.
GET /advanced-person/{process_id}
Endpoint responsável por consultar o andamento do processamento e verificação de antecedentes dos documentos da pessoa.
GET /profiles-list
Endpoint responsável por retornar a lista de perfis de consulta, incluindo os departamentos e serviços associados a cada perfil.
2.2 Autenticação
Para consumir as APIs, você deverá utilizar a API Key disponibilizada na Área do Cliente. Esse código serve para identificar o contrato responsável por esse fluxo de integração.
Exemplo de código
api-key: AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA
Aviso importante!
A API Key identifica seu usuário e seu contrato com o Liberado. Mantenha essas informações protegidas.
Exemplo de requisição com API Key
curl –location ‘https://integration.liberadoapp.com/basic-person/00000000000’ \
–header ‘accept: */*’ \
–header ‘api-key: AAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAA’
2.3 Parâmetros e Formatos
POST /basic-person
- Content-Type: application/json
- Parâmetros:
- name: Nome da pessoa (mínimo 5 caracteres, opcional)
- cpf: CPF da pessoa (obrigatório, 11 dígitos, apenas números)
- rg: RG da pessoa (opcional, máximo 10 dígitos, apenas números)
- data_nascimento: Data de nascimento no formato ISO (YYYY-MM-DD, opcional)
- nome_pai: Nome do pai (opcional)
- nome_mae: Nome da mãe (opcional)
- rg_expedicao: Data de expedição do RG no formato ISO (YYYY-MM-DD, opcional)
- rg_estado_emissor: Estado emissor do RG (sigla de duas letras maiúsculas, opcional)
- perfilConsultaId: ID do perfil de consulta (opcional)
- departamentoId: ID do departamento (obrigatório se perfilConsultaId for fornecido)
POST /advanced-person
- Content-Type: application/json
- Parâmetros:
- documents: Objeto contendo as imagens dos documentos (RG e/ou CNH, frente e verso, em formato base64)
- face: Imagem da selfie da pessoa em formato base64
GET /basic-person/{cpf}
- Parâmetro na URL: cpf (11 dígitos, apenas números)
GET /advanced-person/{process_id}
- Parâmetro na URL: process_id (UUID do processo)
GET /profiles-list
- Não requer parâmetros adicionais no corpo da requisição.
2.4 Exemplo de Requisição
POST /basic-person
curl –location ‘https://integration.liberadoapp.com/basic-person’ \
–header ‘accept: */*’ \
–header ‘api-key: AAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAA’ \
–header ‘Content-Type: application/json’ \
–data ‘{
“name”: “Nome da pessoa”,
“cpf”: “00000000000”,
“rg”: “000000000”,
“data_nascimento”: “1988-11-13”,
“nome_pai”: “Nome do pai”,
“nome_mae”: “Nome da mãe”,
“rg_expedicao”: “1988-11-13”,
“rg_estado_emissor”: “SP”
}’
POST /advanced-person
curl -X ‘POST’ \
‘https://integration.liberadoapp.com/advanced-person’ \
-H ‘accept: */*’ \
-H ‘api-key: AAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAA’ \
-H ‘Content-Type: application/json’ \
-d ‘{
“documents”: {
“rg”: {
“front”: “data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wC … RG frate”,
“back”: “data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wC … RG verso”
},
“cnh”: {
“front”: “data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wC … CNH aberta frente”,
“back”: “data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wC … CNH aberta verson(QrCode)”
}
},
“face”: “data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wC … foto da pessoa no formato selfie”
}’
GET /basic-person/{cpf}
curl –location ‘https://integration.liberadoapp.com/basic-person/00000000000’ \
–header ‘accept: */*’ \
–header ‘api-key: AAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAA’
GET /advanced-person/{process_id}
curl –location ‘https://integration.liberadoapp.com/people/3775bfaa-9585-4805-bd12-58802767b74d’ \
–header ‘accept: */*’ \
–header ‘api-key: AAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAA’
GET /profiles-list
curl –location ‘https://integration.liberadoapp.com/profiles-list’ \
–header ‘accept: */*’ \
–header ‘api-key: AAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAA’
2.5 Exemplo de Resposta
POST /basic-person (Sucesso)
Status: 201 Created
{
“id”: “657da119-780f-45cc-a9a0-f675b1249b77”,
“name”: “Nome da pessoa”,
“cpf”: “00000000000”,
“rg”: “000000000”,
“data_nascimento”: “1988-11-13”,
“nome_pai”: “Nome do pai”,
“nome_mae”: “Nome da mãe”,
“rg_expedicao”: “1988-11-13”,
“rg_estado_emissor”: “SP”
}
POST /basic-person (CPF já cadastrado)
Status: 201 Created
{
“id”: “657da119-780f-45cc-a9a0-f675b1249b77”,
“message”: [
“Já existe um cadastro para o CPF informado. As consultas pendentes, baseadas no perfil de consulta informado, serão executadas.”,
“Já existe um cadastro para o CPF informado. Todas as consultas automáticas foram executadas.”
]
}
POST /basic-person (Erro)
Status: 400 Bad Request
{
“statusCode”: 400,
“message”: [
“O campo \”name\” deve ter no mínimo 5 caracteres”,
“O campo \”name\” não pode estar vazio”,
“CPF inválido. Deve conter apenas números e ter 11 dígitos”,
“RG inválido. Deve conter apenas números e ter no máximo 10 dígitos”,
“Data de nascimento inválida. Deve estar no formato ISO (YYYY-MM-DD)”,
“O campo \”rg_estado_emissor\” deve conter apenas siglas de estados (duas letras maiúsculas)”
],
“error”: “Bad Request”
}
GET /basic-person/{cpf} (Sucesso)
Status: 200 OK
{
“pessoa”: {
“id”: “87768749-b39b-4d92-94fd-5ec6d0047341”,
“createdAt”: “Data de criação”,
“modifiedAt”: “Última modificação”,
“groupsCount”: “Quantidade de grupos”,
“name”: “Nome da pessoa”,
“email”: “Email da pessoa”,
“phone”: “Telefone da pessoa”,
“cpf”: “00000000000”,
“rg”: “RG da pessoa”,
“dob”: “Data de nascimento”,
“data_n出生”: “1981-12-10”,
“docType”: “Tipo de documento”,
“nome_pai”: “Nome do pai”,
“nome_mae”: “Nome da mãe”,
“genero”: “Gênero”,
“rg_expedicao”: “Expedição do RG”,
“rg_estado_emissor”: “Estado emissor do RG”,
“rg_orgao_emissor”: “Órgão emissor”,
“cnh_cat_hab”: “Categoria da CNH”,
“cnh_data_primeira_habilitacao”: “Primeira habilitação”,
“cnh_data_validade”: “Validade da CNH”,
“cnh_data_emissao”: “Emissão da CNH”,
“cnh_registro”: “Registro da CNH”,
“cnh_observacoes”: “Observações”,
“status”: true,
“basic_registration”: true,
“verifiedDoc”: “success”,
“verifiedFacematch”: “pending”,
“verifiedId”: “none”,
“verifiedCriminal”: “success”,
“verifiedSocial”: “none”,
“verifiedCredit”: “pending”,
“verifiedPhone”: “none”,
“verifiedEmail”: “success”,
“termsId”: “ID do termo aceito”,
“verificationProfileId”: “Id do perfil de consulta”,
“groups”: [
{
“id”: “ID do grupo”,
“createdAt”: “Data de criação”,
“modifiedAt”: “Última modificação”,
“name”: “Nome do grupo”,
“cnpj”: “CNPJ do grupo”,
“address”: “Endereço do grupo”,
“city”: “Cidade do grupo”,
“state”: “Estado do grupo”,
“lat”: “Latitude do grupo”,
“lng”: “Longitude do grupo”,
“cep”: “CEP do grupo”,
“operatorsCount”: “Quantidade de operadores”,
“peopleCount”: “Quantidade de pessoas”,
“companiesCount”: “Quantidade de empresas”,
“status”: true,
“expirationActive”: true,
“expirationTime”: “Data de expiração”,
“maxPeopleActive”: true,
“maxPeople”: “Máximo de pessoas”,
“pjAccessActive”: true,
“verificationProfileActive”: true,
“partnerCount”: “Quantidade de parceiros”,
“contactCount”: “Quantidade de contatos”,
“groupServices”: [],
“partner”: {
“id”: “ID do parceiro”,
“createdAt”: “Data de criação”,
“modifiedAt”: “Última modificação”,
“name”: “Nome do parceiro”,
“groupsCount”: “Quantidade de grupos”
}
}
],
“departments”: [
{
“id”: “c54dae7e-a027-431e-ab9e-63ea61a935cf”,
“createdAt”: “Data de criação”,
“modifiedAt”: “Última modificação”,
“name”: “Nome do departamento”,
“description”: “Descrição do departamento”,
“groupId”: “ID do grupo”
}
],
“verificacoes”: {
“identidadeVerificada”: [],
“antecedentesCriminais”: {
“policiaFederal”: [],
“policiaCivil”: [],
“procurados”: [],
“mandadosPrisao”: [],
“trf1”: [],
“trf2”: [],
“trf4”: [],
“trf5”: [],
“trf6”: [],
“kyc”: [],
“processos”: []
},
“credito”: [],
“social”: []
},
“statusVerificacoes”: [
{
“nome”: “identidadeVerificadaAvancada”,
“status”: “concluída”
},
{
“nome”: “identidadeVerificadaBasica”,
“status”: “concluída”
},
{
“nome”: “policiaFederal”,
“status”: “concluída”
},
{
“nome”: “policiaCivil”,
“status”: “concluída”
},
{
“nome”: “procurados”,
“status”: “concluída”
},
{
“nome”: “mandadosPrisao”,
“status”: “concluída”
},
{
“nome”: “trf1”,
“status”: “concluída”
},
{
“nome”: “trf2”,
“status”: “concluída”
},
{
“nome”: “trf4”,
“status”: “concluída”
},
{
“nome”: “trf5”,
“status”: “concluída”
},
{
“nome”: “trf6”,
“status”: “concluída”
},
{
“nome”: “kyc”,
“status”: “concluída”
},
{
“nome”: “processos”,
“status”: “concluída”
},
{
“nome”: “protesto”,
“status”: “concluída”
},
{
“nome”: “boavista”,
“status”: “concluída”
},
{
“nome”: “analiseCredito”,
“status”: “concluída”
},
{
“nome”: “beneficios”,
“status”: “concluída”
}
]
}
}
GET /basic-person/{cpf} (Não encontrado)
Status: 200 OK
{
“pessoa”: {}
}
POST /advanced-person (Sucesso)
Status: 200 OK
{
“process_id”: “3775bfaa-9585-4805-bd12-58802767b74d”,
“groupId”: “43802361-7777-4603-b080-698aaab9328e”,
“docs”: {
“rg”: {
“front”: “integration/3775bfaa-9585-4805-bd12-58802767b74d_0_0”,
“back”: “integration/3775bfaa-9585-4805-bd12-58802767b74d_1_0”
},
“cnh”: {
“front”: “integration/3775bfaa-9585-4805-bd12-58802767b74d_2_0”,
“back”: “integration/3775bfaa-9585-4805-bd12-58802767b74d_3_0”
}
},
“face”: “integration/3775bfaa-9585-4805-bd12-58802767b74d_face_0”
}
GET /advanced-person/{process_id} (Sucesso)
Status: 200 OK
{
“id”: “3775bfaa-9585-4805-bd12-58802767b74d”,
“createdAt”: “2024-04-14T23:44:04.832Z”,
“modifiedAt”: “2024-04-14T23:44:04.832Z”,
“process_id”: “4308fdfb-3b33-40b4-b889-1078824bbde2”,
“status”: “PROCESS_STARTED”,
“descripton”: null,
“logs”: [
{
“id”: “18141c62-ae69-4374-a53b-903528f2fe1d”,
“createdAt”: “2024-04-14T23:45:41.360Z”,
“modifiedAt”: “2024-04-14T23:45:41.360Z”,
“step”: “PROCESS_CNH_FRONT”,
“status”: “SUCCESS”,
“message”: “Documento processado com sucesso.”,
“friendly_message”: “Documento processado com sucesso.”
},
{
“id”: “36945a7a-fb3d-4e4c-bba0-4d3fe8d510d0”,
“createdAt”: “2024-04-14T23:44:55.369Z”,
“modifiedAt”: “2024-04-14T23:44:55.369Z”,
“step”: “PROCESS_RG_FRONT”,
“status”: “SUCCESS”,
“message”: “Documento processado com sucesso.”,
“friendly_message”: “Documento processado com sucesso.”
},
{
“id”: “84ff2ee5-a7fb-43ec-8545-21c18ba57219”,
“createdAt”: “2024-04-14T23:45:44.726Z”,
“modifiedAt”: “2024-04-14T23:45:44.726Z”,
“step”: “PROCESS_CNH_BACK”,
“status”: “SUCCESS”,
“message”: “Documento processado com sucesso.”,
“friendly_message”: “Documento processado com sucesso.”
},
{
“id”: “e9705c40-261c-495f-a971-f7d6e0d52c5c”,
“createdAt”: “2024-04-14T23:44:57.653Z”,
“modifiedAt”: “2024-04-14T23:44:57.653Z”,
“step”: “PROCESS_RG_BACK”,
“status”: “SUCCESS”,
“message”: “Documento processado com sucesso.”,
“friendly_message”: “Documento processado com sucesso.”
}
],
“registration”: [
{
“id”: “c2465af5-95f1-41a9-a50f-1947281606d7”,
“createdAt”: “2024-04-14T06:12:42.854Z”,
“modifiedAt”: “2024-04-15T01:49:52.676Z”,
“isNew”: true,
“person”: {
“id”: “ff8d95a8-0f9b-4d51-881f-f4f4968e2ff9”,
“createdAt”: “2024-04-14T21:07:34.635Z”,
“modifiedAt”: “2024-04-14T21:14:17.000Z”,
“groupsCount”: 1,
“name”: “Nome da pessoa”,
“email”: null,
“phone”: null,
“cpf”: “0000000000”,
“rg”: “0000000”,
“dob”: “12/04/1988”,
“data_nascimento”: null,
“docType”: “RG”,
“nome_pai”: “Nome do pai”,
“nome_mae”: “Nome da mãe”,
“genero”: “FEMININO”,
“rg_expedicao”: “31/03/2016”,
“rg_estado_emissor”: “SP”,
“rg_orgao_emissor”: “Órgão de Trânsito”,
“cnh_cat_hab”: “B”,
“cnh_data_primeira_habilitacao”: “01/07/2011”,
“cnh_data_validade”: “01/08/2033”,
“cnh_data_emissao”: “18/09/2023”,
“cnh_registro”: “05240576438”,
“cnh_observacoes”: “A\nEAR”,
“status”: false,
“basic_registration”: true,
“verifiedDoc”: “success”,
“verifiedFacematch”: “success”,
“verifiedId”: “waiting”,
“verifiedCriminal”: “waiting”,
“verifiedPhone”: “success”,
“verifiedEmail”: “success”,
“termsId”: null,
“photo”: null
}
}
]
}
GET /profiles-list (Sucesso)
Status: 200 OK
[
{
“id”: “7900be90-a25f-4103-b19b-27b5be39e687”,
“name”: “Perfil de Consulta A”,
“departments”: [
{
“id”: “c54dae7e-a027-431e-ab9e-63ea61a935cf”,
“name”: “Departamento X”
},
{
“id”: “b85c8d6b-3d01-42d2-9b26-9f85b18ac1bf”,
“name”: “Departamento Y”
}
],
“services”: [
{
“name”: “Serviço 1”,
“description”: “Descrição do Serviço 1”
},
{
“name”: “Serviço 2”,
“description”: “Descrição do Serviço 2”
}
]
},
{
“id”: “8fe3a33e-d063-43be-8c13-9a749a40f317”,
“name”: “Perfil de Consulta B”,
“departments”: [
{
“id”: “d74d9b01-8fd7-4e1f-b327-56d0e52882c2”,
“name”: “Departamento Z”
}
],
“services”: [
{
“name”: “Serviço A”,
“description”: “Descrição do Serviço A”
}
]
}
]
2.6 Observações e Avisos Importantes
- Host: https://integration.liberadoapp.com
- Como funciona: Para iniciar uma verificação de antecedentes, o interessado envia os dados pessoais ou fotos dos documentos RG e CNH (frente e verso) e a API retorna um identificador do processo iniciado, que pode ser pesquisado a qualquer momento para obter o status das buscas e as informações encontradas.
- Perfil de Consulta: Utilizado para limitar quais serviços serão executados automaticamente no momento do cadastro de uma pessoa. Define verificações específicas (como verificação criminal, análise de crédito, etc.) com base no perfil configurado. O perfilConsultaId e departamentoId devem ser válidos e associados.
- Aviso de Segurança: A API Key identifica seu usuário e contrato com o Liberado. Mantenha essas informações protegidas.
- Erros Comuns:
- 400 Bad Request: Ocorre quando os parâmetros fornecidos são inválidos, como CPF com menos de 11 dígitos, nome com menos de 5 caracteres, ou perfil de consulta/departamento inválidos.
2.6 Observações e Avisos Importantes
- Host: https://integration.liberadoapp.com
- Como funciona: Para iniciar uma verificação de antecedentes, o interessado envia os dados pessoais ou fotos dos documentos RG e CNH (frente e verso) e a API retorna um identificador do processo iniciado, que pode ser pesquisado a qualquer momento para obter o status das buscas e as informações encontradas.
- Perfil de Consulta: Utilizado para limitar quais serviços serão executados automaticamente no momento do cadastro de uma pessoa. Define verificações específicas (como verificação criminal, análise de crédito, etc.) com base no perfil configurado. O perfilConsultaId e departamentoId devem ser válidos e associados.
- Aviso de Segurança: A API Key identifica seu usuário e contrato com o Liberado. Mantenha essas informações protegidas.
- Erros Comuns:
- 400 Bad Request: Ocorre quando os parâmetros fornecidos são inválidos, como CPF com menos de 11 dígitos, nome com menos de 5 caracteres, ou perfil de consulta/departamento inválidos.
3. API CNPJ / Empresa
3.1 Endpoints
POST /basic-company
Endpoint responsável por adicionar uma nova empresa somente com os seus dados básicos.
OBS: O CNPJ é a única propriedade obrigatória.
GET /basic-company/{cnpj}
Endpoint responsável por consultar os dados da empresa cadastrada pelo CNPJ.
GET /profiles-list
Endpoint responsável por retornar a lista de perfis de consulta, incluindo os departamentos e serviços associados a cada perfil.
3.2 Autenticação
Para consumir as APIs, você deverá utilizar a API Key disponibilizada na Área do Cliente. Esse código serve para identificar o contrato responsável por esse fluxo de integração.
Exemplo de código
api-key: AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA
Aviso importante!
A API Key identifica seu usuário e seu contrato com o Liberado. Mantenha essas informações protegidas.
Exemplo de requisição com API Key
curl –location ‘https://integration.liberadoapp.com/basic-company/00000000000000’ \
–header ‘accept: */*’ \
–header ‘api-key: AAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAA’
3.3 Parâmetros e Formatos
POST /basic-company
- Content-Type: application/json
- Parâmetros:
- cnpj: CNPJ da empresa (obrigatório, 14 dígitos, apenas números)
- perfilConsultaId: ID do perfil de consulta (opcional)
- departamentoId: ID do departamento (obrigatório se perfilConsultaId for fornecido)
GET /basic-company/{cnpj}
- Parâmetro na URL: cnpj (14 dígitos, apenas números)
GET /profiles-list
- Não requer parâmetros adicionais no corpo da requisição.
3.4 Exemplo de Requisição
POST /basic-company
2.6 Observações e Avisos Importantes
- Host: https://integration.liberadoapp.com
- Como funciona: Para iniciar uma verificação de antecedentes, o interessado envia os dados pessoais ou fotos dos documentos RG e CNH (frente e verso) e a API retorna um identificador do processo iniciado, que pode ser pesquisado a qualquer momento para obter o status das buscas e as informações encontradas.
- Perfil de Consulta: Utilizado para limitar quais serviços serão executados automaticamente no momento do cadastro de uma pessoa. Define verificações específicas (como verificação criminal, análise de crédito, etc.) com base no perfil configurado. O perfilConsultaId e departamentoId devem ser válidos e associados.
- Aviso de Segurança: A API Key identifica seu usuário e contrato com o Liberado. Mantenha essas informações protegidas.
- Erros Comuns:
- 400 Bad Request: Ocorre quando os parâmetros fornecidos são inválidos, como CPF com menos de 11 dígitos, nome com menos de 5 caracteres, ou perfil de consulta/departamento inválidos.
3. API CNPJ / Empresa
3.1 Endpoints
POST /basic-company
Endpoint responsável por adicionar uma nova empresa somente com os seus dados básicos.
OBS: O CNPJ é a única propriedade obrigatória.
GET /basic-company/{cnpj}
Endpoint responsável por consultar os dados da empresa cadastrada pelo CNPJ.
GET /profiles-list
Endpoint responsável por retornar a lista de perfis de consulta, incluindo os departamentos e serviços associados a cada perfil.
3.2 Autenticação
Para consumir as APIs, você deverá utilizar a API Key disponibilizada na Área do Cliente. Esse código serve para identificar o contrato responsável por esse fluxo de integração.
Exemplo de código
api-key: AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA
Aviso importante!
A API Key identifica seu usuário e seu contrato com o Liberado. Mantenha essas informações protegidas.
Exemplo de requisição com API Key
curl –location ‘https://integration.liberadoapp.com/basic-company/00000000000000’ \
–header ‘accept: */*’ \
–header ‘api-key: AAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAA’
3.3 Parâmetros e Formatos
POST /basic-company
- Content-Type: application/json
- Parâmetros:
- cnpj: CNPJ da empresa (obrigatório, 14 dígitos, apenas números)
- perfilConsultaId: ID do perfil de consulta (opcional)
- departamentoId: ID do departamento (obrigatório se perfilConsultaId for fornecido)
GET /basic-company/{cnpj}
- Parâmetro na URL: cnpj (14 dígitos, apenas números)
GET /profiles-list
- Não requer parâmetros adicionais no corpo da requisição.
3.4 Exemplo de Requisição
POST /basic-company
curl –location ‘https://integration.liberadoapp.com/basic-company’ \
–header ‘accept: */*’ \
–header ‘api-key: AAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAA’ \
–header ‘Content-Type: application/json’ \
–data ‘{
“cnpj”: “00000000000000”,
“perfilConsultaId”: “7900be90-a25f-4103-b19b-27b5be39e687”,
“departamentoId”: “c54dae7e-a027-431e-ab9e-63ea61a935cf”
}’
GET /basic-company/{cnpj}
curl –location ‘https://integration.liberadoapp.com/basic-company/00000000000000’ \
–header ‘accept: */*’ \
–header ‘api-key: AAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAA’
GET /profiles-list
curl –location ‘https://integration.liberadoapp.com/profiles-list’ \
–header ‘accept: */*’ \
–header ‘api-key: AAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAA’
3.5 Exemplo de Resposta
POST /basic-company (Sucesso)
Status: 201 Created
{
“id”: “c334ca87-ae40-4122-a5df-e1443f2fdc95”,
“cnpj”: “00000000000000”,
“verifiedRegistration”: “success”,
“officialName”: “Nome oficial da empresa”,
“tradeName”: “Nome fantasia da empresa”,
“perfilConsultaId”: “7900be90-a25f-4103-b19b-27b5be39e687”,
“departamentoId”: “c54dae7e-a027-431e-ab9e-63ea61a935cf”
}
POST /basic-company (CNPJ já cadastrado)
Status: 201 Created
{
“id”: “657da119-780f-45cc-a9a0-f675b1249b77”,
“message”: [
“Já existe um cadastro para o CNPJ informado. As consultas pendentes, baseadas no perfil de consulta informado, serão executadas.”,
“Já existe um cadastro para o CNPJ informado. Todas as consultas automáticas foram executadas.”
]
}
POST /basic-company (Erro)
Status: 400 Bad Request
{
“statusCode”: 400,
“message”: [
“O CNPJ informado nãj} (Sucesso)
Status: 200 OK
{
“pessoa”: {
“id”: “87768749-b39b-4d92-94fd-5ec6d0047341”,
“createdAt”: “Data de criação”,
“modifiedAt”: “Última modificação”,
“groupsCount”: “Quantidade de grupos”,
“cnpj”: “00000000000000”,
“officialName”: “Nome oficial”,
“tradeName”: “Nome fantasia”,
“status”: true,
“verificationProfileId”: “Id do perfil de consulta”,
“verifiedRegistration”: “Situação da esfera cadastral”,
“verifiedCredit”: “Situação da esfera financeira”,
“verifiedTax”: “Situação da esfera fiscal”,
“verifiedLabor”: “Situação da esfera trabalhista”,
“verifiedCriminal”: “Situação da esfera judicial”,
“verifiedCompliance”: “Situação da esfera compliance”,
“groups”: [
{
“id”: “ID do grupo”,
“createdAt”: “Data de criação”,
“modifiedAt”: “Última modificação”,
“name”: “Nome do grupo”,
“cnpj”: “CNPJ do grupo”,
“address”: “Endereço do grupo”,
“city”: “Cidade do grupo”,
“state”: “Estado do grupo”,
“lat”: “Latitude do grupo”,
“lng”: “Longitude do grupo”,
“cep”: “CEP do grupo”,
“operatorsCount”: “Quantidade de operadores”,
“peopleCount”: “Quantidade de pessoas”,
“companiesCount”: “Quantidade de empresas”,
“status”: true,
“expirationActive”: true,
“expirationTime”: “Data de expiração”,
“maxPeopleActive”: true,
“maxPeople”: “Máximo de pessoas”,
“pjAccessActive”: true,
“verificationProfileActive”: true,
“partnerCount”: “Quantidade de parceiros”,
“contactCount”: “Quantidade de contatos”,
“groupServices”: [],
“partner”: {
“id”: “ID do parceiro”,
“createdAt”: “Data de criação”,
“modifiedAt”: “Última modificação”,
“name”: “Nome do parceiro”,
“groupsCount”: “Quantidade de grupos”
}
}
],
“departments”: [
{
“id”: “c54dae7e-a027-431e-ab9e-63ea61a935cf”,
“createdAt”: “Data de criação”,
“modifiedAt”: “Última modificação”,
“name”: “Nome do departamento”,
“description”: “Descrição do departamento”,
“groupId”: “ID do grupo”
}
],
“verificacoes”: {
“dadosCadastrais”: {
“dadosCadastrais”: [],
“representantesLegais”: [],
“participacaoSocietaria”: [],
“mandadosPrisao”: []
},
“dadosFinanceiros”: {
“analiseDeRisco”: [],
“dadosRestritivosDeCredito”: []
},
“dadosJudiciais”: {
“processosJudiciaisEAdministrativos”: [],
“distribuicaoDeProcessosSocios”: []
},
“dadosTrabalhistas”: {
“certidaoFgts”: [],
“certidaoNegativaDeDebitosTrabalhistas”: []
},
“dadosFiscais”: {
“certidaoPgfn”: []
},
“dadosCompliance”: {
“kycECompliance”: []
}
},
“statusVerificacoes”: [
{
“nome”: “dadosCadastrais”,
“status”: “concluída”
},
{
“nome”: “representantesLegais”,
“status”: “concluída”
},
{
“nome”: “participacaoSocietaria”,
“status”: “concluída”
},
{
“nome”: “analiseDeRisco”,
“status”: “concluída”
},
{
“nome”: “dadosRestritivosDeCredito”,
“status”: “concluída”
},
{
“nome”: “distribuicaoDeProcessosSocios”,
“status”: “concluída”
},
{
“nome”: “certidaoFgts”,
“status”: “concluída”
},
{
“nome”: “certidaoNegativaDeDebitosTrabalhistas”,
“status”: “concluída”
},
{
“nome”: “certidaoPgfn”,
“status”: “concluída”
},
{
“nome”: “kycECompliance”,
“status”: “concluída”
}
]
}
}
GET /basic-company/{cnpj} (Não encontrado)
Status: 200 OK
{
“pessoa”: {
“id”: “87768749-b39b-4d92-94fd-5ec6d0047341”,
“createdAt”: “Data de criação”,
“modifiedAt”: “Última modificação”,
“groupsCount”: “Quantidade de grupos”,
“cnpj”: “00000000000000”,
“officialName”: “Nome oficial”,
“tradeName”: “Nome fantasia”,
“status”: true,
“verificationProfileId”: “Id do perfil de consulta”,
“verifiedRegistration”: “Situação da esfera cadastral”,
“verifiedCredit”: “Situação da esfera financeira”,
“verifiedTax”: “Situação da esfera fiscal”,
“verifiedLabor”: “Situação da esfera trabalhista”,
“verifiedCriminal”: “Situação da esfera judicial”,
“verifiedCompliance”: “Situação da esfera compliance”,
“groups”: [
{
“id”: “ID do grupo”,
“createdAt”: “Data de criação”,
“modifiedAt”: “Última modificação”,
“name”: “Nome do grupo”,
“cnpj”: “CNPJ do grupo”,
“address”: “Endereço do grupo”,
“city”: “Cidade do grupo”,
“state”: “Estado do grupo”,
“lat”: “Latitude do grupo”,
“lng”: “Longitude do grupo”,
“cep”: “CEP do grupo”,
“operatorsCount”: “Quantidade de operadores”,
“peopleCount”: “Quantidade de pessoas”,
“companiesCount”: “Quantidade de empresas”,
“status”: true,
“expirationActive”: true,
“expirationTime”: “Data de expiração”,
“maxPeopleActive”: true,
“maxPeople”: “Máximo de pessoas”,
“pjAccessActive”: true,
“verificationProfileActive”: true,
“partnerCount”: “Quantidade de parceiros”,
“contactCount”: “Quantidade de contatos”,
“groupServices”: [],
“partner”: {
“id”: “ID do parceiro”,
“createdAt”: “Data de criação”,
“modifiedAt”: “Última modificação”,
“name”: “Nome do parceiro”,
“groupsCount”: “Quantidade de grupos”
}
}
],
“departments”: [
{
“id”: “c54dae7e-a027-431e-ab9e-63ea61a935cf”,
“createdAt”: “Data de criação”,
“modifiedAt”: “Última modificação”,
“name”: “Nome do departamento”,
“description”: “Descrição do departamento”,
“groupId”: “ID do grupo”
}
],
“verificacoes”: {
“dadosCadastrais”: {
“dadosCadastrais”: [],
“representantesLegais”: [],
“participacaoSocietaria”: [],
“mandadosPrisao”: []
},
“dadosFinanceiros”: {
“analiseDeRisco”: [],
“dadosRestritivosDeCredito”: []
},
“dadosJudiciais”: {
“processosJudiciaisEAdministrativos”: [],
“distribuicaoDeProcessosSocios”: []
},
“dadosTrabalhistas”: {
“certidaoFgts”: [],
“certidaoNegativaDeDebitosTrabalhistas”: []
},
“dadosFiscais”: {
“certidaoPgfn”: []
},
“dadosCompliance”: {
“kycECompliance”: []
}
},
“statusVerificacoes”: [
{
“nome”: “dadosCadastrais”,
“status”: “concluída”
},
{
“nome”: “representantesLegais”,
“status”: “concluída”
},
{
“nome”: “participacaoSocietaria”,
“status”: “concluída”
},
{
“nome”: “analiseDeRisco”,
“status”: “concluída”
},
{
“nome”: “dadosRestritivosDeCredito”,
“status”: “concluída”
},
{
“nome”: “distribuicaoDeProcessosSocios”,
“status”: “concluída”
},
{
“nome”: “certidaoFgts”,
“status”: “concluída”
},
{
“nome”: “certidaoNegativaDeDebitosTrabalhistas”,
“status”: “concluída”
},
{
“nome”: “certidaoPgfn”,
“status”: “concluída”
},
{
“nome”: “kycECompliance”,
“status”: “concluída”
}
]
}
}
GET /basic-company/{cnpj} (Não encontrado)
Status: 200 OK
{
“empresa”: {}
}
GET /profiles-list (Sucesso)
Status: 200 OK
[
{
“id”: “7900be90-a25f-4103-b19b-27b5be39e687”,
“name”: “Perfil de Consulta A”,
“departments”: [
{
“id”: “c54dae7e-a027-431e-ab9e-63ea61a935cf”,
“name”: “Departamento X”
},
{
“id”: “b85c8d6b-3d01-42d2-9b26-9f85b18ac1bf”,
“name”: “Departamento Y”
}
],
“services”: [
{
“name”: “Serviço 1”,
“description”: “Descrição do Serviço 1”
},
{
“name”: “Serviço 2”,
“description”: “Descrição do Serviço 2”
}
]
},
{
“id”: “8fe3a33e-d063-43be-8c13-9a749a40f317”,
“name”: “Perfil de Consulta B”,
“departments”: [
{
“id”: “d74d9b01-8fd7-4e1f-b327-56d0e52882c2”,
“name”: “Departamento Z”
}
],
“services”: [
{
“name”: “Serviço A”,
“description”: “Descrição do Serviço A”
}
]
}
]
3.6 Observações e Avisos Importantes
- Host: https://integration.liberadoapp.com
- Como funciona: Você envia o CNPJ da empresa para a API, que processa a solicitação e realiza a busca em fontes confiáveis.
- Perfil de Consulta: Utilizado para limitar quais serviços serão executados automaticamente no momento do cadastro de uma empresa. Define verificações específicas (como verificação fiscal, judicial, etc.) com base no perfil configurado. O perfilConsultaId e departamentoId devem ser válidos e associados.
- Aviso de Segurança: A API Key identifica seu usuário e contrato com o Liberado. Mantenha essas informações protegidas.
- Erros Comuns:
- 400 Bad Request: Ocorre quando o CNPJ informado é inválido (menos de 14 dígitos ou contém caracteres não numéricos) ou quando o perfil de consulta/departamento é inválido
GET /basic-company/{cnpj} (Não encontrado)
Status: 200 OK
{
“empresa”: {}
}
GET /profiles-list (Sucesso)
Status: 200 OK
[
{
“id”: “7900be90-a25f-4103-b19b-27b5be39e687”,
“name”: “Perfil de Consulta A”,
“departments”: [
{
“id”: “c54dae7e-a027-431e-ab9e-63ea61a935cf”,
“name”: “Departamento X”
},
{
“id”: “b85c8d6b-3d01-42d2-9b26-9f85b18ac1bf”,
“name”: “Departamento Y”
}
],
“services”: [
{
“name”: “Serviço 1”,
“description”: “Descrição do Serviço 1”
},
{
“name”: “Serviço 2”,
“description”: “Descrição do Serviço 2”
}
]
},
{
“id”: “8fe3a33e-d063-43be-8c13-9a749a40f317”,
“name”: “Perfil de Consulta B”,
“departments”: [
{
“id”: “d74d9b01-8fd7-4e1f-b327-56d0e52882c2”,
“name”: “Departamento Z”
}
],
“services”: [
{
“name”: “Serviço A”,
“description”: “Descrição do Serviço A”
}
]
}
]
3.6 Observações e Avisos Importantes
- Host: https://integration.liberadoapp.com
- Como funciona: Você envia o CNPJ da empresa para a API, que processa a solicitação e realiza a busca em fontes confiáveis.
- Perfil de Consulta: Utilizado para limitar quais serviços serão executados automaticamente no momento do cadastro de uma empresa. Define verificações específicas (como verificação fiscal, judicial, etc.) com base no perfil configurado. O perfilConsultaId e departamentoId devem ser válidos e associados.
- Aviso de Segurança: A API Key identifica seu usuário e contrato com o Liberado. Mantenha essas informações protegidas.
- Erros Comuns:
- 400 Bad Request: Ocorre quando o CNPJ informado é inválido (menos de 14 dígitos ou contém caracteres não numéricos) ou quando o perfil de consulta/departamento é inválido.
4. Contato para Suporte Técnico
Para dúvidas ou suporte técnico relacionado à integração com as APIs da Liberado App, entre em contato com nossa equipe de suporte através do e-mail suporte@liberadoapp.com ou acesse a Área do Cliente em https://liberadoapp.com.
Documentação de Integração – API Liberado App
