Pular para o conteúdo principal

Certificação da Norma Reguladora 20 (Novo)

Modelo na Plataforma

Sigla: NR20

Descrição: Certificação da Norma Reguladora 20 (Novo)

Modelo Via API

Type: 72

Este modelo extrai informações-chave de um Certificação da Norma Reguladora 20 (Novo) (NR20).

O processo de extração é assíncrono e consiste em dois passos principais:

  1. Enviar o documento para a fila de processamento.
  2. Consultar o resultado após a conclusão do processamento.

Passo 1: Enviar o Documento para Processamento​

Para iniciar a extração, envie uma requisição POST para o endpoint abaixo.

POST URL Ambiente/documents/upload

Headers​

IdentificadorValor
Content-Typemultipart/form-data
IDEXA-API-KEYsua_api_key

Payload (Corpo da Requisição)​

A requisição deve conter os seguintes parâmetros obrigatórios:

ParâmetroDescriçaoTipo
filesO arquivo do documento a ser processado.File
typeCódigo interno do modelo. Use 72 para NR20_V2.Integer

Os parâmetros a seguir são opcionais:

ParâmetroDescriçaoTipo
pagesDefine páginas específicas para análise (ex: "1,2,5-10").String
externalIdId externo para seu controle (não pode repetir).String

Exemplos de Requisição​

curl -X POST "URL_BASE/documents/upload" \
-H "IDEXA-API-KEY: sua_api_key" \
-H "Content-Type: multipart/form-data" \
-F "files=@/path/to/seu/documento.pdf" \
-F "type=72" \
-F "externalId=pedido-cliente-123"

Resposta Imediata (Status 200)​

A resposta confirma o recebimento. Guarde o id para consultar o resultado no próximo passo.

{
"id": "95893394-337c-429c-a63e-1b8210de47d2",
"externalId": "pedido-cliente-123",
"type": 72,
"status": 0,
"statusDesc": "RECEIVED",
"createdAt": "2026-01-07T14:38:50.045Z",
"updatedAt": "2026-01-07T14:38:50.045Z"
}
Processamento Assíncrono

A extração de dados pode levar alguns segundos. Por isso, a API funciona de forma assíncrona. Após enviar o documento, aguarde um momento e então use o id retornado para consultar o resultado final. Para ser notificado automaticamente, considere utilizar nossos Webhooks.

Passo 2: Consultar o Resultado​

Use o id do documento para fazer uma requisição GET e buscar o resultado completo da extração.

GET URL Ambiente/documents/[id]

Resposta Final (Status 200)​

Quando o status for 1 (FINISHED), o objeto data conterá os campos extraídos.

Exemplo de Resposta Completa
{
"id": "95893394-337c-429c-a63e-1b8210de47d2",
"externalId": "pedido-cliente-123",
"type": 72,
"data": {
"date": "2025-08-04 to 2025-08-05",
"name": "JOÃO DA SILVA SANTOS",
"place": "SÃO PAULO - SP",
"expire": "2027-08-05",
"number": "2025/000123",
"emission": "2025-08-05",
"signatures": [
{
"name": "MARIA OLIVEIRA COSTA",
"position": "INSTRUTORA"
}
],
"course_name": "SEGURANÇA E SAÚDE NO TRABALHO COM INFLAMÁVEIS E COMBUSTÍVEIS - NR-20 BÁSICO",
"member_code": "123.456.789-00",
"program_content": true,
"certificate_code": "NR-20",
"driver_signature": true,
"certifying_company": "TREINA SEGURANÇA LTDA",
"document_validation": true
},
"processTime": 8.123,
"status": 1,
"statusDesc": "FINISHED",
"createdAt": "2026-01-07T14:38:50.045Z",
"updatedAt": "2026-01-07T14:38:58.168Z"
}

Dicionário de Dados: Certificação da Norma Reguladora 20 (Novo)​

Estes são os campos retornados dentro do objeto data.

CampoTipoDescriçãoExemplo
dateStringdate"2025-08-04 to 2025-08-05"
nameStringname"JOÃO DA SILVA SANTOS"
placeStringplace"SÃO PAULO - SP"
expireStringexpire"2027-08-05"
numberStringnumber"2025/000123"
emissionStringemission"2025-08-05"
signatures[].nameStringname"MARIA OLIVEIRA COSTA"
signatures[].positionStringposition"INSTRUTORA"
courseNameStringcourse_name"SEGURANÇA E SAÚDE NO TRABALHO COM INFLAMÁVEIS E COMBUSTÍVEIS - NR-20 BÁSICO"
memberCodeStringmember_code"123.456.789-00"
programContentBooleanprogram_contenttrue
certificateCodeStringcertificate_code"NR-20"
driverSignatureBooleandriver_signaturetrue
certifyingCompanyStringcertifying_company"TREINA SEGURANÇA LTDA"
documentValidationBooleandocument_validation""