Skip to main content
POST
/
api
/
v1
/
background-check
/
pf
Realiza background check (KYC) de uma pessoa física.
curl --request POST \
  --url https://flex-hml.flexdoc-apis.com.br/services/api/v1/background-check/pf \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form cpf=123 \
  --form 'callBackUrl=<string>' \
  --form responseFormat=json \
  --form 'basicAuth=<string>'
{
  "guid": "<string>"
}

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

Preencha os dados necessários para iniciar o background check de uma pessoa física. A resposta será enviada para a URL de callback informada.

​
cpf
integer<int32>
required

CPF da pessoa que será verificada. Deve conter apenas números, sem pontos ou traços.

​
callBackUrl
string<uri>
required

URL que receberá automaticamente o dossiê gerado após a conclusão do background check.

​
responseFormat
enum<string>
required

Escolha o formato do dossiê que será enviado para o callback (JSON ou PDF).

Available options:
json,
pdf
​
basicAuth
string<username:password>

Credenciais para autenticação básica (Basic Auth) da URL de callback, no formato usuario:senha. Opcional: preencha apenas se o endpoint de callback exigir autenticação.

Response

201 - application/json

Background check iniciado com sucesso. GUID do dossiê será retornado.

​
guid
string