Chile COW

Permite verificar a validade e status das cédulas de identidade chilenas, integrando-se ao sistema COW (Certificate of Validity) do Registro Civil do Chile.

Endpoint

POST /civil-registry/vigencia-cow

Autenticação

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

Corpo da solicitação

Content-Type: application/json

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
RUN	string	Sim	Número de identificação chileno do usuário, incluindo o dígito verificador.
credentialNumber	string	Sim	Número único de credencial associado à identificação.

Exemplo de solicitação

curl --location '{IDENTITY_API_BASE_URL}/civil-registry/vigencia-cow' \
--header 'x-api-key: {API_KEY}' \
--data-raw '{
  "RUN": "12345678-9",
  "credentialNumber": "000000000"
}'

Respostas

200 Sucesso

Parâmetros de resposta

Parâmetro	Tipo	Obrigatório	Descrição
responseData	object	Sim	Contém os dados da transação.
identity	array	Sim	Contém os detalhes da identidade.

Parâmetros de resposta — responseData

Parâmetro	Tipo	Obrigatório	Descrição
idTransaction	string	Sim	Identificador único da transação.
transactionDate	string	Sim	Data da transação no formato YYYY-MM-DD.
statusTransaction	string	Sim	Status da transação. Valores possíveis: 000 (ACK), 201 (Erro técnico), 206 (Formato inválido), 301 (Dados inexistentes), 304 (Qualidade deficiente), 306 (Sem impressão digital fornecida)
errorDescription	string	Sim	Descrição do status da transação. Valores possíveis: ACK, Erro técnico, Formato inválido, Dados inexistentes, Qualidade deficiente, Sem impressão digital fornecida

Parâmetros de resposta — identity

Parâmetro	Tipo	Obrigatório	Descrição
RUN	string	Sim	Número de identificação nacional chileno (RUT).
credentialProfileId	string	Sim	Tipo de credencial. Valores possíveis: CEDULA, CEDULA_EXT, Passaporte, DOC_VIAJE, TITULO_VIAJE, SALVO_CONDUCTO
credentialNumber	string	Sim	Número de documento associado à credencial.
expiryDate	string	Sim	Data de expiração da credencial.
validityStatus	string	Sim	Estado de vigência da credencial. Valores possíveis: VIGENTE, NO_VIGENTE
status	string	Sim	Estado detalhado da credencial. Valores possíveis: NÃO BLOQUEADO, CRIAÇÃO/RENOVAÇÃO, TEMPORÁRIO, TEMPORÁRIO PERMANENTE, DEFINITIVO

Exemplo de resposta

{
  "responseData": {
    "idTransaction": "03a10a56-cf9f-4248-bd60-5ce992562930",
    "transactionDate": "2024-12-13",
    "statusTransaction": "000",
    "errorDescription": "ACK"
  },
  "identity": [
    {
      "status": "NÃO BLOQUEADO",
      "run": "12345678-9",
      "credentialProfileId": "CEDULA",
      "credentialNumber": "000000000",
      "expiryDate": "2029-06-22",
      "validityStatus": "VIGENTE"
    }
  ]
}

400 Requisição inválida

{
  "status": 400,
  "title": "Bad Request",
  "detail": "Invalid request.",
  "type": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400",
  "errors": []
}

401 Não autorizado

{
  "message": "Unauthorized"
}

403 Acesso negado

{
  "Message": "User is not authorized to access this resource with an explicit deny"
}

502 Gateway inválido

{
  "status": 502,
  "title": "Bad Gateway",
  "detail": "Server got an invalid response.",
  "type": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502"
}

504 Tempo limite do gateway

{
  "message": "Endpoint request timed out"
}