Skip to main content
POST
/
id-check
/
api
/
v1
/
scan
/
fingers
ID Check Impressão Digital
curl --request POST \
  --url https://api.valid.com/id-check/api/v1/scan/fingers \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "cpf": "<string>",
  "fingers": [
    {
      "position": 123,
      "image": "<string>"
    }
  ]
}
'
import requests

url = "https://api.valid.com/id-check/api/v1/scan/fingers"

payload = {
    "cpf": "<string>",
    "fingers": [
        {
            "position": 123,
            "image": "<string>"
        }
    ]
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({cpf: '<string>', fingers: [{position: 123, image: '<string>'}]})
};

fetch('https://api.valid.com/id-check/api/v1/scan/fingers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.valid.com/id-check/api/v1/scan/fingers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'cpf' => '<string>',
    'fingers' => [
        [
                'position' => 123,
                'image' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.valid.com/id-check/api/v1/scan/fingers"

	payload := strings.NewReader("{\n  \"cpf\": \"<string>\",\n  \"fingers\": [\n    {\n      \"position\": 123,\n      \"image\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.valid.com/id-check/api/v1/scan/fingers")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cpf\": \"<string>\",\n  \"fingers\": [\n    {\n      \"position\": 123,\n      \"image\": \"<string>\"\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.valid.com/id-check/api/v1/scan/fingers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cpf\": \"<string>\",\n  \"fingers\": [\n    {\n      \"position\": 123,\n      \"image\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

 {
      "scanId": "32c2775c-4d15-4201-be32-5886a397be6d",
      "cpf": "11144477735",
      "fingers": [
          {
              "position": 1,
              "confidence": "maximum"
          },
          {
              "position": 2,
              "confidence": "high"
          }
      ],
      "metadata": {
          "processingTime": 4269,
          "timestamp": "2026-04-20T19:04:17.412Z"
      }
  }
{
  "error": "VALIDATION_ERROR",
  "message": "Invalid request parameters",
  "requestId": "123e4567-e89b-12d3-a456-426614174000",
  "timestamp": "2025-10-21T10:00:00Z"
}

Request Body

cpf
string
required
CPF do titular a ser verificado.Exemplo: 12312312300
fingers
array
required
Lista de impressões digitais a serem verificadas. Cada item representa uma digital com sua posição e imagem biométrica.

Response

scanId
string
Identificador interno da transação.Exemplo: 123e4567-e89b-12d3-a456-426614174000
cpf
string
CPF consultado.Exemplo: 12312312300
fingers
array
Lista com o resultado individual de cada digital verificada.
processingTime
integer
Tempo total de processamento em milisegundosExemplo: 345
timestamp
datetime
Data e hora da transaçãoExemplo: 2025-11-21T18:00:00Z

 {
      "scanId": "32c2775c-4d15-4201-be32-5886a397be6d",
      "cpf": "11144477735",
      "fingers": [
          {
              "position": 1,
              "confidence": "maximum"
          },
          {
              "position": 2,
              "confidence": "high"
          }
      ],
      "metadata": {
          "processingTime": 4269,
          "timestamp": "2026-04-20T19:04:17.412Z"
      }
  }
{
  "error": "VALIDATION_ERROR",
  "message": "Invalid request parameters",
  "requestId": "123e4567-e89b-12d3-a456-426614174000",
  "timestamp": "2025-10-21T10:00:00Z"
}