Skip to main content
POST
/
api
/
v1
/
fraud
/
analysis
CPF e documento
curl --request POST \
  --url https://flex-hml.flexdoc-apis.com.br/services/api/v1/fraud/analysis \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form cpf=12345678900 \
  --form imageFront='@example-file' \
  --form imageBack='@example-file'
{
  "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": {
    "faceCrop": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA...",
    "match": true,
    "similarity": 92.5
  }
}

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.

Body

multipart/form-data

Dados multipart contendo CPF e imagens (frente e verso) do documento.

Payload para solicitação de análise de fraude, contendo dados pessoais e imagens do documento.

cpf
string
required

CPF (somente números).

Example:

12345678900

imageFront
file
required

Imagem do documento (pode ser apenas frente ou frente e verso unidos em uma única imagem), nos formatos JPEG, PNG ou PDF.

imageBack
file

Imagem do verso do documento nos formatos JPEG, PNG ou PDF.

Response

Resultado da análise de fraude retornado com sucesso.

Objeto de resposta com o resultado completo da análise de fraude, incluindo scores, OCR e biometria facial.

scoreResult
object

Resultado da análise de score do processo de onboarding, incluindo penalidades e estatísticas.

extractResult
object

Detalhes dos resultados de extração e validação de dados.

faceMatchResult
object

Resultado da comparação facial entre imagem de documento e selfie.