Get KYC By Document

curl --request POST \
  --url https://api.sandbox.wepayout.com.br/v1/kyc/document/{cpf_or_cnpj} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document": "<string>"
}
'

import requests

url = "https://api.sandbox.wepayout.com.br/v1/kyc/document/{cpf_or_cnpj}"

payload = { "document": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({document: '<string>'})
};

fetch('https://api.sandbox.wepayout.com.br/v1/kyc/document/{cpf_or_cnpj}', 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.sandbox.wepayout.com.br/v1/kyc/document/{cpf_or_cnpj}",
  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([
    'document' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.sandbox.wepayout.com.br/v1/kyc/document/{cpf_or_cnpj}"

	payload := strings.NewReader("{\n  \"document\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.sandbox.wepayout.com.br/v1/kyc/document/{cpf_or_cnpj}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"document\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.wepayout.com.br/v1/kyc/document/{cpf_or_cnpj}")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"document\": \"<string>\"\n}"

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

{
  "id": 348,
  "origin_request": "PAYOUT",
  "description": " Compliance approved KYC without document upload",
  "info_add": null,
  "created_at": "2022-06-14 17:15:41",
  "updated_at": "2023-10-03 16:01:28",
  "merchant": "Merchant Name",
  "submerchant": null,
  "status": {
    "id": 3,
    "name": "Approved"
  },
  "reason": {
    "id": 17,
    "name": "Payout: Limit BRL 100K Usual"
  },
  "persons": [
    {
      "id": 390,
      "name": "Person name",
      "legal_name": null,
      "document": "83562580061",
      "type_person": "Beneficiary"
    }
  ],
  "document_required": [
    {
      "status": true,
      "label": "Document proving the origin and destination of the operation"
    },
    {
      "status": true,
      "label": "Proof of residence"
    },
    {
      "status": true,
      "label": "Personal document"
    },
    {
      "status": true,
      "label": "Beneficiary Full Name"
    },
    {
      "status": true,
      "label": "Email"
    },
    {
      "status": true,
      "label": "Phone"
    },
    {
      "status": true,
      "label": "Nationality"
    },
    {
      "status": true,
      "label": "Profession (Occupation)"
    }
  ],
  "documents": [
    {
      "id": 652,
      "status_id": 3,
      "status_name": "Approved",
      "document_id": 1,
      "document_name": "invoice",
      "collection_name": null,
      "collection_id": null,
      "value_field": "https://bucket-name.s3.us-east-1.amazonaws.com/path/to/file",
      "rejection_reason": null,
      "label": "Document proving the origin and destination of the operation",
      "type_field": "file",
      "required_field": true,
      "expires_at": null,
      "automaticatic_validation": 0
    },
    {
      "id": 653,
      "status_id": 3,
      "status_name": "Approved",
      "document_id": 2,
      "document_name": "address",
      "collection_name": null,
      "collection_id": null,
      "value_field": "https://bucket-name.s3.us-east-1.amazonaws.com/path/to/file",
      "rejection_reason": null,
      "label": "Proof of residence",
      "type_field": "file",
      "required_field": true,
      "expires_at": null,
      "automaticatic_validation": 0
    },
    {
      "id": 654,
      "status_id": 3,
      "status_name": "Approved",
      "document_id": 3,
      "document_name": "personal-document",
      "collection_name": null,
      "collection_id": null,
      "value_field": "https://bucket-name.s3.us-east-1.amazonaws.com/path/to/file",
      "rejection_reason": null,
      "label": "Personal document",
      "type_field": "file",
      "required_field": true,
      "expires_at": null,
      "automaticatic_validation": 0
    },
    {
      "id": 655,
      "status_id": 3,
      "status_name": "Approved",
      "document_id": 5,
      "document_name": "full-name-beneficiary",
      "collection_name": null,
      "collection_id": null,
      "value_field": null,
      "rejection_reason": null,
      "label": "Beneficiary Full Name",
      "type_field": "text",
      "required_field": true,
      "expires_at": null,
      "automaticatic_validation": 0
    },
    {
      "id": 656,
      "status_id": 3,
      "status_name": "Approved",
      "document_id": 7,
      "document_name": "email",
      "collection_name": null,
      "collection_id": null,
      "value_field": null,
      "rejection_reason": null,
      "label": "Email",
      "type_field": "text",
      "required_field": true,
      "expires_at": null,
      "automaticatic_validation": 0
    },
    {
      "id": 657,
      "status_id": 3,
      "status_name": "Approved",
      "document_id": 8,
      "document_name": "phone",
      "collection_name": null,
      "collection_id": null,
      "value_field": null,
      "rejection_reason": null,
      "label": "Phone",
      "type_field": "text",
      "required_field": true,
      "expires_at": null,
      "automaticatic_validation": 0
    },
    {
      "id": 658,
      "status_id": 3,
      "status_name": "Approved",
      "document_id": 11,
      "document_name": "nationality",
      "collection_name": null,
      "collection_id": null,
      "value_field": null,
      "rejection_reason": null,
      "label": "Nationality",
      "type_field": "text",
      "required_field": true,
      "expires_at": null,
      "automaticatic_validation": 0
    },
    {
      "id": 659,
      "status_id": 3,
      "status_name": "Approved",
      "document_id": 9,
      "document_name": "profession",
      "collection_name": null,
      "collection_id": null,
      "value_field": null,
      "rejection_reason": null,
      "label": "Profession (Occupation)",
      "type_field": "text",
      "required_field": true,
      "expires_at": null,
      "automaticatic_validation": 0
    }
  ]
}

[]

{
  "message": "Not found"
}

POST

kyc

document

{cpf_or_cnpj}

Get KYC By Document

curl --request POST \
  --url https://api.sandbox.wepayout.com.br/v1/kyc/document/{cpf_or_cnpj} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document": "<string>"
}
'

import requests

url = "https://api.sandbox.wepayout.com.br/v1/kyc/document/{cpf_or_cnpj}"

payload = { "document": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({document: '<string>'})
};

fetch('https://api.sandbox.wepayout.com.br/v1/kyc/document/{cpf_or_cnpj}', 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.sandbox.wepayout.com.br/v1/kyc/document/{cpf_or_cnpj}",
  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([
    'document' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.sandbox.wepayout.com.br/v1/kyc/document/{cpf_or_cnpj}"

	payload := strings.NewReader("{\n  \"document\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.sandbox.wepayout.com.br/v1/kyc/document/{cpf_or_cnpj}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"document\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.wepayout.com.br/v1/kyc/document/{cpf_or_cnpj}")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"document\": \"<string>\"\n}"

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

{
  "id": 348,
  "origin_request": "PAYOUT",
  "description": " Compliance approved KYC without document upload",
  "info_add": null,
  "created_at": "2022-06-14 17:15:41",
  "updated_at": "2023-10-03 16:01:28",
  "merchant": "Merchant Name",
  "submerchant": null,
  "status": {
    "id": 3,
    "name": "Approved"
  },
  "reason": {
    "id": 17,
    "name": "Payout: Limit BRL 100K Usual"
  },
  "persons": [
    {
      "id": 390,
      "name": "Person name",
      "legal_name": null,
      "document": "83562580061",
      "type_person": "Beneficiary"
    }
  ],
  "document_required": [
    {
      "status": true,
      "label": "Document proving the origin and destination of the operation"
    },
    {
      "status": true,
      "label": "Proof of residence"
    },
    {
      "status": true,
      "label": "Personal document"
    },
    {
      "status": true,
      "label": "Beneficiary Full Name"
    },
    {
      "status": true,
      "label": "Email"
    },
    {
      "status": true,
      "label": "Phone"
    },
    {
      "status": true,
      "label": "Nationality"
    },
    {
      "status": true,
      "label": "Profession (Occupation)"
    }
  ],
  "documents": [
    {
      "id": 652,
      "status_id": 3,
      "status_name": "Approved",
      "document_id": 1,
      "document_name": "invoice",
      "collection_name": null,
      "collection_id": null,
      "value_field": "https://bucket-name.s3.us-east-1.amazonaws.com/path/to/file",
      "rejection_reason": null,
      "label": "Document proving the origin and destination of the operation",
      "type_field": "file",
      "required_field": true,
      "expires_at": null,
      "automaticatic_validation": 0
    },
    {
      "id": 653,
      "status_id": 3,
      "status_name": "Approved",
      "document_id": 2,
      "document_name": "address",
      "collection_name": null,
      "collection_id": null,
      "value_field": "https://bucket-name.s3.us-east-1.amazonaws.com/path/to/file",
      "rejection_reason": null,
      "label": "Proof of residence",
      "type_field": "file",
      "required_field": true,
      "expires_at": null,
      "automaticatic_validation": 0
    },
    {
      "id": 654,
      "status_id": 3,
      "status_name": "Approved",
      "document_id": 3,
      "document_name": "personal-document",
      "collection_name": null,
      "collection_id": null,
      "value_field": "https://bucket-name.s3.us-east-1.amazonaws.com/path/to/file",
      "rejection_reason": null,
      "label": "Personal document",
      "type_field": "file",
      "required_field": true,
      "expires_at": null,
      "automaticatic_validation": 0
    },
    {
      "id": 655,
      "status_id": 3,
      "status_name": "Approved",
      "document_id": 5,
      "document_name": "full-name-beneficiary",
      "collection_name": null,
      "collection_id": null,
      "value_field": null,
      "rejection_reason": null,
      "label": "Beneficiary Full Name",
      "type_field": "text",
      "required_field": true,
      "expires_at": null,
      "automaticatic_validation": 0
    },
    {
      "id": 656,
      "status_id": 3,
      "status_name": "Approved",
      "document_id": 7,
      "document_name": "email",
      "collection_name": null,
      "collection_id": null,
      "value_field": null,
      "rejection_reason": null,
      "label": "Email",
      "type_field": "text",
      "required_field": true,
      "expires_at": null,
      "automaticatic_validation": 0
    },
    {
      "id": 657,
      "status_id": 3,
      "status_name": "Approved",
      "document_id": 8,
      "document_name": "phone",
      "collection_name": null,
      "collection_id": null,
      "value_field": null,
      "rejection_reason": null,
      "label": "Phone",
      "type_field": "text",
      "required_field": true,
      "expires_at": null,
      "automaticatic_validation": 0
    },
    {
      "id": 658,
      "status_id": 3,
      "status_name": "Approved",
      "document_id": 11,
      "document_name": "nationality",
      "collection_name": null,
      "collection_id": null,
      "value_field": null,
      "rejection_reason": null,
      "label": "Nationality",
      "type_field": "text",
      "required_field": true,
      "expires_at": null,
      "automaticatic_validation": 0
    },
    {
      "id": 659,
      "status_id": 3,
      "status_name": "Approved",
      "document_id": 9,
      "document_name": "profession",
      "collection_name": null,
      "collection_id": null,
      "value_field": null,
      "rejection_reason": null,
      "label": "Profession (Occupation)",
      "type_field": "text",
      "required_field": true,
      "expires_at": null,
      "automaticatic_validation": 0
    }
  ]
}

[]

{
  "message": "Not found"
}

Get KYC By Document

This data can be used in the “kyc-proof-url” of a KYC. If no document is found for this cpf/cnpj, the request will return an empty array. If a KYC with the provided document exists, only the most recent KYC record for that document will be returned. When you provide a cpf or cnpj, you will be informed.

Path Parameters

cpf_or_cnpj

string

required

CPF or CNPJ document number

Body

document

string

required

Provide either a CPF or CNPJ number (digits only, no special characters)

Response

integer

Unique identifier for the KYC record.

origin_request

string

Identifier or reference of the original request that triggered this KYC process.Example: PAYIN or PAYOUT

description

string

Textual description or details about the KYC request.

info_add

string

Additional information.

created_at

string

Date and time when the KYC record was created.Format: YYYY-MM-DD HH:mm:ss

updated_at

string

Date and time of the last update made to this KYC record.Format: YYYY-MM-DD HH:mm:ss

merchant

string

Name of the main merchant associated with the KYC process.

submerchant

string

Name of the submerchant involved in the KYC process.

status

object

Object representing the current status of the KYC.

Show Status Object

integer

Status identifier.Example: 1

name

string

Name of the status.Example: Waiting Upload Documents, Waiting Approval Documents, Approved, Pending Regularization or Canceled

reason

object

Object representing the reason for the KYC request.

Show Reason Object

integer

Reason identifier.

name

string

Name or description of the reason.Example: Payout: Limit BRL 100K Usual

persons

array

List of people or entities involved in the KYC process.

Show Person Object

integer

Unique identifier of the person.

name

string

Common or display name of the person.

legal_name

string

Legal name.

document

string

Document number.

type_person

string

Type of person.Example: Beneficiary

document_required

array

List of required document types for this person.

Show Document Required Object

status

boolean

Indicates whether this document is required for the KYC process.

label

string

Display label for the required document.

documents

array

List of uploaded documents related to the KYC.

Show Document Object

integer

Unique identifier of the uploaded document.

status_id

integer

Current validation status ID.

status_name

string

Name of the status.

document_id

integer

ID of the uploaded document.

document_name

string

Name of the document.

collection_name

string

Name of the document collection or group, if applicable.

collection_id

integer

Identifier of the document collection.

value_field

string

URL for downloading the uploaded document file.

rejection_reason

string

Reason for rejection if the document was not approved.

label

string

Label or description used to identify the document field.

type_field

string

Input type.Example: file or text

required_field

boolean

Whether this document is required for KYC completion.

expires_at

string

Expiration date of the document.

automaticatic_validation

integer

Indicates if the document supports automatic validation.Example: 1 = yes, 0 = no

Request Example

curl --request POST \
  --url 'https://api.sandbox.wepayout.com.br/v1/kyc/document/12345678900' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer 123' \
  --header 'Content-Type: application/json' \
  --data '{
    "document": "12345678901"
  }'

curl --request POST \
  --url 'https://api.sandbox.wepayout.com.br/v1/kyc/document/12345678000190' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer 123' \
  --header 'Content-Type: application/json' \
  --data '{
    "document": "12345678000190"
  }'

async function getKYCByDocument(document) {
  const response = await fetch(
    `https://api.sandbox.wepayout.com.br/v1/kyc/document/${document}`,
    {
      method: 'POST',
      headers: {
        'Accept': 'application/json',
        'Authorization': 'Bearer 123',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        document: document
      })
    }
  );
  
  if (!response.ok) {
    throw new Error(`Failed to fetch KYC: ${response.statusText}`);
  }
  
  return await response.json();
}

// Usage - CPF
const kycByCPF = await getKYCByDocument('12345678900');
console.log('KYC by CPF:', kycByCPF);

// Usage - CNPJ
const kycByCNPJ = await getKYCByDocument('12345678000190');
console.log('KYC by CNPJ:', kycByCNPJ);

import requests

def get_kyc_by_document(document):
    url = f'https://api.sandbox.wepayout.com.br/v1/kyc/document/{document}'
    headers = {
        'Accept': 'application/json',
        'Authorization': 'Bearer 123',
        'Content-Type': 'application/json'
    }
    
    data = {
        'document': document
    }
    
    response = requests.post(url, headers=headers, json=data)
    response.raise_for_status()
    
    return response.json()

# Usage - CPF
kyc_by_cpf = get_kyc_by_document('12345678900')
print('KYC by CPF:', kyc_by_cpf)

# Usage - CNPJ
kyc_by_cnpj = get_kyc_by_document('12345678000190')
print('KYC by CNPJ:', kyc_by_cnpj)

{
  "id": 348,
  "origin_request": "PAYOUT",
  "description": " Compliance approved KYC without document upload",
  "info_add": null,
  "created_at": "2022-06-14 17:15:41",
  "updated_at": "2023-10-03 16:01:28",
  "merchant": "Merchant Name",
  "submerchant": null,
  "status": {
    "id": 3,
    "name": "Approved"
  },
  "reason": {
    "id": 17,
    "name": "Payout: Limit BRL 100K Usual"
  },
  "persons": [
    {
      "id": 390,
      "name": "Person name",
      "legal_name": null,
      "document": "83562580061",
      "type_person": "Beneficiary"
    }
  ],
  "document_required": [
    {
      "status": true,
      "label": "Document proving the origin and destination of the operation"
    },
    {
      "status": true,
      "label": "Proof of residence"
    },
    {
      "status": true,
      "label": "Personal document"
    },
    {
      "status": true,
      "label": "Beneficiary Full Name"
    },
    {
      "status": true,
      "label": "Email"
    },
    {
      "status": true,
      "label": "Phone"
    },
    {
      "status": true,
      "label": "Nationality"
    },
    {
      "status": true,
      "label": "Profession (Occupation)"
    }
  ],
  "documents": [
    {
      "id": 652,
      "status_id": 3,
      "status_name": "Approved",
      "document_id": 1,
      "document_name": "invoice",
      "collection_name": null,
      "collection_id": null,
      "value_field": "https://bucket-name.s3.us-east-1.amazonaws.com/path/to/file",
      "rejection_reason": null,
      "label": "Document proving the origin and destination of the operation",
      "type_field": "file",
      "required_field": true,
      "expires_at": null,
      "automaticatic_validation": 0
    },
    {
      "id": 653,
      "status_id": 3,
      "status_name": "Approved",
      "document_id": 2,
      "document_name": "address",
      "collection_name": null,
      "collection_id": null,
      "value_field": "https://bucket-name.s3.us-east-1.amazonaws.com/path/to/file",
      "rejection_reason": null,
      "label": "Proof of residence",
      "type_field": "file",
      "required_field": true,
      "expires_at": null,
      "automaticatic_validation": 0
    },
    {
      "id": 654,
      "status_id": 3,
      "status_name": "Approved",
      "document_id": 3,
      "document_name": "personal-document",
      "collection_name": null,
      "collection_id": null,
      "value_field": "https://bucket-name.s3.us-east-1.amazonaws.com/path/to/file",
      "rejection_reason": null,
      "label": "Personal document",
      "type_field": "file",
      "required_field": true,
      "expires_at": null,
      "automaticatic_validation": 0
    },
    {
      "id": 655,
      "status_id": 3,
      "status_name": "Approved",
      "document_id": 5,
      "document_name": "full-name-beneficiary",
      "collection_name": null,
      "collection_id": null,
      "value_field": null,
      "rejection_reason": null,
      "label": "Beneficiary Full Name",
      "type_field": "text",
      "required_field": true,
      "expires_at": null,
      "automaticatic_validation": 0
    },
    {
      "id": 656,
      "status_id": 3,
      "status_name": "Approved",
      "document_id": 7,
      "document_name": "email",
      "collection_name": null,
      "collection_id": null,
      "value_field": null,
      "rejection_reason": null,
      "label": "Email",
      "type_field": "text",
      "required_field": true,
      "expires_at": null,
      "automaticatic_validation": 0
    },
    {
      "id": 657,
      "status_id": 3,
      "status_name": "Approved",
      "document_id": 8,
      "document_name": "phone",
      "collection_name": null,
      "collection_id": null,
      "value_field": null,
      "rejection_reason": null,
      "label": "Phone",
      "type_field": "text",
      "required_field": true,
      "expires_at": null,
      "automaticatic_validation": 0
    },
    {
      "id": 658,
      "status_id": 3,
      "status_name": "Approved",
      "document_id": 11,
      "document_name": "nationality",
      "collection_name": null,
      "collection_id": null,
      "value_field": null,
      "rejection_reason": null,
      "label": "Nationality",
      "type_field": "text",
      "required_field": true,
      "expires_at": null,
      "automaticatic_validation": 0
    },
    {
      "id": 659,
      "status_id": 3,
      "status_name": "Approved",
      "document_id": 9,
      "document_name": "profession",
      "collection_name": null,
      "collection_id": null,
      "value_field": null,
      "rejection_reason": null,
      "label": "Profession (Occupation)",
      "type_field": "text",
      "required_field": true,
      "expires_at": null,
      "automaticatic_validation": 0
    }
  ]
}

[]

{
  "message": "Not found"
}

Use Cases

Search KYC by Document

Retrieve KYC information using a CPF or CNPJ document:

async function searchByDocument(document) {
  try {
    const kyc = await getKYCByDocument(document);
    
    if (Array.isArray(kyc) && kyc.length === 0) {
      console.log('No KYC found for this document');
      return null;
    }
    
    const person = kyc.persons[0];
    console.log(`Found KYC for ${person.name}`);
    console.log(`Document: ${person.document}`);
    console.log(`Status: ${kyc.status.name}`);
    console.log(`Reason: ${kyc.reason.name}`);
    
    return kyc;
  } catch (error) {
    console.error('Error searching KYC:', error);
  }
}

Check Document Status

Check the status and documents for a specific document number:

async function checkDocumentStatus(document) {
  try {
    const kyc = await getKYCByDocument(document);
    
    if (Array.isArray(kyc) && kyc.length === 0) {
      return { found: false };
    }
    
    const approvedDocs = kyc.documents.filter(doc => doc.status_id === 3);
    
    return {
      found: true,
      status: kyc.status.name,
      totalDocuments: kyc.documents.length,
      approvedDocuments: approvedDocs.length,
      persons: kyc.persons.map(p => p.name)
    };
  } catch (error) {
    console.error('Error checking document status:', error);
  }
}

Validate Document Before Transaction

Check if a document has an approved KYC before processing a transaction:

async function validateDocumentForTransaction(document) {
  const kyc = await getKYCByDocument(document);
  
  if (Array.isArray(kyc) && kyc.length === 0) {
    return {
      valid: false,
      reason: 'No KYC record found'
    };
  }
  
  const isApproved = kyc.status.id === 3;
  
  return {
    valid: isApproved,
    kycId: kyc.id,
    status: kyc.status.name,
    reason: isApproved ? 'KYC approved' : `KYC status: ${kyc.status.name}`
  };
}

// Usage
const validation = await validateDocumentForTransaction('12345678900');
if (validation.valid) {
  console.log('Document validated, proceed with transaction');
} else {
  console.log(`Cannot proceed: ${validation.reason}`);
}

Get Most Recent KYC

Since this endpoint returns only the most recent KYC, use it to check current status:

async function getMostRecentKYC(document) {
  const kyc = await getKYCByDocument(document);
  
  if (Array.isArray(kyc) && kyc.length === 0) {
    return null;
  }
  
  const person = kyc.persons[0];
  
  return {
    id: kyc.id,
    person: person.name,
    document: person.document,
    personType: person.type_person,
    status: kyc.status.name,
    reason: kyc.reason.name,
    lastUpdate: kyc.updated_at,
    createdAt: kyc.created_at
  };
}

Best Practices

Document Format: Send only digits in the document field, without special characters like dots, hyphens, or slashes.

Most Recent Record: This endpoint returns only the most recent KYC record for the provided document. If you need historical records, use the List KYC endpoint.

Empty Array: An empty array response indicates no KYC record exists for the provided document, which is different from a 404 error.

List KYC

List all KYC verifications

Get KYC By ID

Get KYC by ID

Create Charge

Create a new charge

Create Payment

Create a payout payment

Get KYC By ID Submit Document For KYC

Account

Banks

Payin

Payout

KYC

Markup

Get KYC By Document

Get KYC By Document

Path Parameters

Body

Response

Request Example

Use Cases

Best Practices

List KYC

Get KYC By ID

Create Charge

Create Payment

​Get KYC By Document

​Path Parameters

​Body

​Response

​Request Example

​Use Cases

​Best Practices

​Related Resources

List KYC

Get KYC By ID

Create Charge

Create Payment

Get KYC By Document

Path Parameters

Body

Response

Request Example

Use Cases

Best Practices

Related Resources