Skip to main content
GET
https://api.sandbox.wepayout.com.br
/
v1
/
kyc
/
{id}
Get KYC By ID
curl --request GET \
  --url https://api.sandbox.wepayout.com.br/v1/kyc/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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
    }
  ]
}

​
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

​
id
string
required
KYC ID

​
Response

​
id
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.
​
reason
object
Object representing the reason for the KYC request.
​
persons
array
List of people or entities involved in the KYC process.
​
document_required
array
List of required document types for this person.
​
documents
array
List of uploaded documents related to the KYC.

​
Request Example

curl --request GET \
  --url '"https://api.sandbox.wepayout.com.br/v1/kyc/{id}"' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer 123'

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

List KYC

List all KYC verifications

Get Balance

Check account balance

Create Charge

Create a new charge

Create Payment

Create a payout payment