Busca CAC

Busca empresas registradas na Comissão de Assuntos Corporativos (CAC) da Nigéria por nome ou número de registro (RC number).

Endpoint

GET /kyc/nga/cac/search

Autenticação

Tipo	Localização	Nome
API Key	Cabeçalho	x-api-key

Parâmetros de consulta

Parâmetro	Tipo	Obrigatório	Descrição
search	string	Sim	Nome da empresa ou número RC a ser pesquisado.

Exemplo de solicitação

GET /kyc/nga/cac/search?search=acme

Respostas

200 Sucesso

Parâmetros de resposta

Parâmetro	Tipo	Descrição
serviceResultCode	integer	Código que indica o resultado geral da execução do serviço. Ver Código de Resultado do Serviço
serviceTime	string	Tempo de processamento (milissegundos).
serviceResultLog	string	Campo descritivo do resultado da execução do serviço. Inclui detalhes quando há um erro ou exceção no módulo.
serviceTransactionId	string	Identificador de transação associado à solicitação processada pela API.
data	array	Array com as empresas encontradas (sem objeto contêiner). Veja a tabela abaixo.

Parâmetros de resposta — data[]

Cada elemento do array representa uma empresa registrada na CAC:

Parâmetro	Tipo	Descrição
id	integer	Identificador único da empresa no banco de dados da CAC.
approved_name	string	Nome registrado (aprovado) da empresa.
rc_number	string	Número de registro (RC Number).
classification	string	Classificação da entidade. Valores possíveis: company, business, IT
classification_id	integer	Código numérico da classificação.
active	boolean	Indica se a empresa está atualmente ativa.
registration_approved	boolean	Indica se o registro está aprovado.
registration_date	string	Data de registro (formato ISO 8601).
business_commencement_date	string | null	Data de início das atividades.
head_office_address	string	Endereço da sede.
branch_address	string	Endereço da filial.
address	string	Endereço físico.
city	string	Cidade.
state	string	Status.
lga	string	Área de Governo Local (LGA).
email	string	E-mail de contato.
objectives	string	Objeto social / atividade declarada.
company_type_name	string | null	Tipo de empresa.
nature_of_business_name	string | null	Natureza do negócio.
delisting_status	string | null	Status de baixa do registro (se aplicável).

Código de Resultado do Serviço

O serviceResultCode indica o resultado geral da execução do serviço:

serviceResultCode	Descrição	Código HTTP
200	A execução do serviço foi bem-sucedida, o módulo processou a solicitação corretamente.	200

Exemplo de resposta

{
  "serviceResultCode": 200,
  "serviceTime": "1200",
  "serviceResultLog": "Success",
  "serviceTransactionId": "b18e902f-01f9-8e0i-e53e-9f3589eg99gh",
  "data": [
    {
      "id": 300075,
      "approved_name": "ACME TECHNOLOGIES NIGERIA LIMITED",
      "rc_number": "1234567",
      "classification": "company",
      "classification_id": 2,
      "active": true,
      "registration_approved": true,
      "registration_date": "2020-05-15T00:00:00.000+00:00",
      "business_commencement_date": null,
      "head_office_address": "1 MAIN STREET, IKEJA",
      "branch_address": "",
      "address": "LEKKI PHASE 1",
      "city": "IKEJA LGA",
      "state": "LAGOS",
      "lga": "",
      "email": "",
      "objectives": "",
      "company_type_name": null,
      "nature_of_business_name": null,
      "delisting_status": null
    },
    {
      "id": 300076,
      "approved_name": "ACME MICROFINANCE BANK LIMITED",
      "rc_number": "7654321",
      "classification": "company",
      "classification_id": 2,
      "active": true,
      "registration_approved": true,
      "registration_date": "2018-03-22T00:00:00.000+00:00",
      "business_commencement_date": null,
      "head_office_address": "12 AWOLOWO ROAD, IKOYI",
      "branch_address": "",
      "address": "IKOYI",
      "city": "ETI-OSA LGA",
      "state": "LAGOS",
      "lga": "",
      "email": "",
      "objectives": "",
      "company_type_name": null,
      "nature_of_business_name": null,
      "delisting_status": null
    }
  ]
}

400 Requisição inválida

Erro retornado com o envelope do serviço (serviceResultCode reflete o código HTTP da resposta):

{
  "serviceResultCode": 400,
  "serviceResultLog": "Desculpe, a consulta falhou. Verifique os dados e tente novamente",
  "serviceTime": "151",
  "serviceTransactionId": "08ac9699-dc9e-4cdc-81d7-264f71838309"
}

502 Gateway inválido

É retornado quando o serviço está temporariamente indisponível ou sua resposta não pôde ser interpretada. O corpo usa o envelope do serviço com serviceResultCode: 500:

{
  "serviceResultCode": 500,
  "serviceResultLog": "Serviço temporariamente indisponível. Tente novamente mais tarde",
  "serviceTime": "3000",
  "serviceTransactionId": "38de2932-0f2h-7gff-14g0-597h04161632"
}

504 Tempo esgotado no gateway

Erro de Timeout, retornado com o envelope do serviço:

{
  "serviceResultCode": 504,
  "serviceResultLog": "Timeout da solicitação. Tente novamente",
  "serviceTime": "30000",
  "serviceTransactionId": "48ef3043-1g3i-8hgg-25h1-608i15272743"
}

Os erros de autenticação (401/403) são rejeitados pelo gateway antes de chegar ao serviço e não usam o envelope serviceResultCode. Os erros de validação da plataforma usam o formato application/problem+json. Consulte Tratamento de erros para ver os detalhes das três formas de resposta.