Get KYC By ID

curl --request GET \
  --url https://api.sandbox.wepayout.com.br/v1/kyc/{id} \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sandbox.wepayout.com.br/v1/kyc/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.wepayout.com.br/v1/kyc/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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
    }
  ]
}

{
  "error": "KYC not found",
  "message": "No KYC record found with the provided ID"
}

GET

kyc

{id}

Get KYC By ID

curl --request GET \
  --url https://api.sandbox.wepayout.com.br/v1/kyc/{id} \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sandbox.wepayout.com.br/v1/kyc/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.wepayout.com.br/v1/kyc/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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
    }
  ]
}

{
  "error": "KYC not found",
  "message": "No KYC record found with the provided ID"
}

Get KYC By ID

This route is performed using the KYC ID. If a KYC with the provided ID exists, it will be retrieved; otherwise, an empty response will be returned.

Path Parameters

string

required

KYC ID

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 GET \
  --url '"https://api.sandbox.wepayout.com.br/v1/kyc/{id}"' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer 123'

async function getKYCById(kycId) {
  const response = await fetch(
    `https://api.sandbox.wepayout.com.br/v1/kyc/${kycId}`,
    {
      method: 'GET',
      headers: {
        'Accept': 'application/json',
        'Authorization': 'Bearer 123'
      }
    }
  );
  
  if (!response.ok) {
    throw new Error(`Failed to fetch KYC: ${response.statusText}`);
  }
  
  return await response.json();
}

// Usage
const kyc = await getKYCById(123);
console.log('KYC details:', kyc);

import requests

def get_kyc_by_id(kyc_id):
    url = f'https://api.sandbox.wepayout.com.br/v1/kyc/{kyc_id}'
    headers = {
        'Accept': 'application/json',
        'Authorization': 'Bearer 123'
    }
    
    response = requests.get(url, headers=headers)
    response.raise_for_status()
    
    return response.json()

# Usage
kyc = get_kyc_by_id(123)
print('KYC details:', kyc)

{
  "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
    }
  ]
}

{
  "error": "KYC not found",
  "message": "No KYC record found with the provided ID"
}

List KYC

List all KYC verifications

Get Balance

Check account balance

Create Charge

Create a new charge

Create Payment

Create a payout payment

List KYC Get KYC By Document

Account

Banks

Payin

Payout

KYC

Markup

Get KYC By ID

Get KYC By ID

Path Parameters

Response

Request Example

List KYC

Get Balance

Create Charge

Create Payment

​Get KYC By ID

​Path Parameters

​Response

​Request Example

​Related Resources

List KYC

Get Balance

Create Charge

Create Payment

Get KYC By ID

Path Parameters

Response

Request Example

Related Resources