| API | Forma de um sistema conversar com outro sistema por meio de requisições |
| Endpoint | URL específica que executa uma operação |
| Request | Chamada enviada para a API |
| Response | Resposta retornada pela API |
| Método HTTP | Tipo da operação, como GET ou POST |
| Header | Informação enviada junto da chamada, como autenticação ou tipo de conteúdo |
| Body | Conteúdo enviado no request, geralmente em JSON |
| JSON | Formato de dados usado nos exemplos da API |
| Base URL | Endereço inicial do ambiente, como HML ou produção |
| HML | Ambiente de homologação, usado para testes |
| Produção | Ambiente usado para consultas reais |
| Token | Código temporário usado para autenticar chamadas |
| JWT | Formato do token de autenticação retornado pela API |
| Bearer | Tipo de autenticação usado no header Authorization |
client | Identificador da aplicação usado para gerar token |
secret | Segredo da aplicação usado para gerar token |
service | Campo que define qual produto será executado em POST /api/service-api |
| CPF | Documento de pessoa física |
| CNPJ | Documento de pessoa jurídica |
result | Objeto com os dados retornados pelo serviço |
status.code | Código técnico do processamento |
status.message | Mensagem técnica do processamento |
externalId | Identificador externo da consulta, quando retornado |
| OCR | Extração de dados de documentos por imagem |
| FaceMatch | Comparação facial entre duas imagens |
| Liveness | Validação de prova de vida |
| KYC | Processo de conhecimento e validação de cliente |
| PEP | Pessoa politicamente exposta |
