Skip to main content
GET
/
api
/
v1
/
steps
/
result
/
{requestId}
Obtem o resultado de um processo
curl --request GET \
  --url https://flex-hml.flexdoc-apis.com.br/services/api/v1/steps/result/{requestId} \
  --header 'Authorization: Bearer <token>'
{
  "livenessResponse": {
    "selfieImage": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA...",
    "createdAt": "2023-01-01T12:00:00.000Z",
    "requestId": "05be75cc-8f8a-414a-891f-434aa9b4e7a5",
    "isAlive": true
  },
  "validationResponse": {
    "createdAt": "2023-01-01T12:00:00.000Z",
    "requestId": "05be75cc-8f8a-414a-891f-434aa9b4e7a5",
    "phoneNumber": 11991234567,
    "isCodeValid": true
  },
  "fraudResponse": {
    "createdAt": "2023-01-01T12:00:00.000Z",
    "requestId": "05be75cc-8f8a-414a-891f-434aa9b4e7a5",
    "documentImage": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA...",
    "scoreResult": {
      "cpf": 12345678901,
      "customerId": "CUST_123456",
      "score": 85,
      "hardStop": false,
      "penalties": [
        {
          "rulesName": "RULE_01",
          "rulesPenalty": 15,
          "hardStop": false,
          "message": "CNH com menos de 2 meses para vencer"
        }
      ],
      "statistics": {
        "batchId": 12345,
        "methodName": "analyzeDocument",
        "totalTime": 1500
      }
    },
    "extractResult": {
      "ocr": {
        "typeRecognized": "rg",
        "typeParentAlias": "di",
        "digitalDocument": true,
        "fields": [
          {
            "key": "nome",
            "value": "João da Silva",
            "conf": 0.95,
            "bbox": [
              12,
              34,
              56,
              78
            ],
            "fields": "<unknown>"
          }
        ],
        "errorMessage": "Falha ao processar imagem: formato inválido"
      }
    },
    "faceMatchResult": {
      "createdAt": "2023-01-01T12:00:00.000Z",
      "requestId": "05be75cc-8f8a-414a-891f-434aa9b4e7a5",
      "similarity": 87.3,
      "isMatch": true
    }
  }
}

Authorizations

​
Authorization
string
header
required

Autentica o acesso a partir de usuário e senha e retorna o Bearer token JWT. Copie o access_token retornado e utilize-o no header Authorization para acessar os endpoints da API.

Path Parameters

​
requestId
string
required

Identificador único da solicitação.

Example:

12345

Response

Resultado obtido com sucesso.

Resposta do processo, que pode conter um dos seguintes resultados dependendo do tipo de processo solicitado.

​
livenessResponse
object

Resultado do processo de verificação de vivacidade, se aplicável.

​
validationResponse
object

Resultado do processo de validação, se aplicável.

​
fraudResponse
object

Resultado do processo de detecção de fraude, se aplicável.