BPN OpenAPI
  1. KYB
BPN OpenAPI
  • Getting Started
    • Introduction to BPN
    • Key Concepts & Terminology
    • Architecture Overview
  • Onboarding & Prerequisites
    • Product Demo
    • Sandbox & Test Environment
  • Use Case
    • Transfer
    • Vault
    • On/Off Ramp
    • Compliance (Travel Rule Information Submission)
    • Fiat Collection(BRL PIX for example)
  • API Reference
    • KYB
      • Share KYB Info For Sub User
        POST
      • Get KYB Sub User Status
        GET
    • Account Management
      • add bank account
      • list bank account
      • create virtaul account
      • list virtual account
      • Master VA balance inquiry
      • list virtual account orders
      • refund virtual account order
    • Wallet
      • Get Asset Balance
      • Get Deposit Address
      • Add Deposit Sender
      • Add Withdraw Whitelist
      • Delete Withdraw Whiltelist
      • Request Withdraw
      • Query Transaction History
    • FX
      • fx inquery
    • BPN Transactions
      • get stablecoin quote
      • create stable order
      • get order (single) detail
      • list orders(batch)
    • Reconciliation
  • Webhooks & Event
    • resend fail webhook
      POST
    • Open Virtual Account Status
      POST
    • virtual account payment status
      POST
    • Transaction Status Notification
      POST
    • KYB Status Notification
      POST
    • Deposit Sender Detail Required
      POST
  • Appendix
    • Enum
    • Virtual Account(VA) Support List
  • Release Notes & Changelog
    • Version History
    • Version History
  • Schemas
    • walletBalance
    • walletAddress
    • transactionRecord
  1. KYB

Get KYB Sub User Status

GET
/v1/kyb/user
Purpose:
To check the current KYB verification status for your corporate user.
What this endpoint does:
Returns the verification status, last update time, and any pending actions or rejection reasons, enabling clients to track onboarding progress.
Keynotes:
Requires authentication via business token.
Statuses may include approved, rejected, pending, or RFI (Request for Information).
For rejected status, failReason will be returned.
For RFI status, pendingAction will describe required additional steps.
May include expireDate for time-sensitive approvals.

Request

Query Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1/kyb/user?subUserId'

Responses

🟢200OK
application/json
Body

Example
{
    "status": "200",
    "code": null,
    "msg": null,
    "traceId": "Auto:bf288b9af2e04dff88e943f2dcaf2b03",
    "data": {
        "kybStatus": "RFI",
        "lastUpdated": "2025-08-08T12:34:56Z",
        "pendingAction": "Provide certified proof of business address",
        "expireDate": "2025-08-15T23:59:59Z"
    }
}
Previous
Share KYB Info For Sub User
Next
add bank account
Built with