1. Partner Flow
BPN OpenAPI
  • Getting Started
    • Introduction to BPN
    • Key Concepts & Terminology
    • Architecture Overview
  • Onboarding & Prerequisites
    • Product Demo
    • Sandbox & Test Environment
    • Signature Authentication Mechanism
  • Use Case
    • Transfer
    • Vault
    • On/Off Ramp
    • Compliance (Travel Rule Information Submission)
    • Fiat Collection(BRL PIX for example)
  • API Reference
    • KYB
      • Share KYB/KYC Info For Sub User
      • Get KYB Sub User Status
    • Account Management
      • Inquiry Master VA Balance
      • List Primary Virtual Accounts
      • Create Virtaul Account
      • Get Virtual Account Detail
      • List Virtual Account
      • Send Email Verify Code
      • Query bank info by account number
      • Payout via Virtual Account
      • Refund Virtual Account Order
      • Get Virtual Account Order Detail
      • List Virtual Account Orders
      • Submit Invoice
      • Get Invoice list Status
      • List Banks
      • Add Bank Account
      • List Bank Account
      • List RFI Sub Virtual Account
      • Get Sub Virtual Account RFI Template Info
      • Sub Virtual Account Submit RFI
    • Wallet
      • List Wallets
      • List Sub Account
      • Create Sub Account
      • Wallet Internal Transfer
      • Query Wallet Internal Transfer Detail
      • List Wallet Internal Transfer order
      • Get Asset Balance
      • Get Deposit Address
      • Add Deposit Sender
      • Add Withdraw Whitelist
      • Delete Withdraw Whiltelist
      • Request Withdraw
      • Query Transaction History
    • FX
      • Inquery FX Rate
    • BPN Transactions
      • Get Stablecoin Quote
      • Create Stable Order
      • Get Order (Single) Detail
      • List Orders(Batch)
    • Reconciliation
      • Get Reconciliation Order List By Page
    • Crypto Payment Link
      • Abnormal fund
        • Abnormal funds
        • Matchable Payment links
        • Link Order(Abnormal fund)
        • Submit to platform
      • Create Payment Link
      • List Payment links
      • Get Curreny Network Config
    • External Provider
      • FE: Create stablecoin collection sub-account link
      • Create stablecoin collection sub-account link
      • Get sub wallet account
      • List sub wallet accounts
      • Change sub wallet status
      • Query stablecoin collection order list
      • Query stablecoin collection order status
      • Get quote
      • Accept stablecoin collection order
      • Reject stablecoin collection order
      • Query USD balance
      • USD Payout (withdrawal)
      • Query USD Payout order status
      • Query USD Payout order list
    • Mock
      • Mock Virtual account Payin Order
      • Mock wallet deposit transaction
      • Mock Payin Order Refund
      • Mock Payout Order Update Status
    • Pay Session
      • Request Pay Session
  • Webhooks & Events
    • Resend Fail Webhook
    • Open Virtual Account Status
    • Virtual Account Payment Status
    • Virtual Account Invoice update
    • Transaction Status Notification
    • KYB Status Notification
    • Deposit Sender Detail Required
    • Abnormal Fund Notification
    • WALLET_TRANSFER_ORDER_UPDATED
    • Sub Virtual Account RFI Required
    • Sub Wallet Update
    • wallet address whitelist Copy
    • Crypto Deposit Order Notification
    • Collect Order Updated
    • Usd Payout Order Updated
    • onboard result
    • partner order status
  • Partner Flow
    • inquiry supported currency
      GET
    • KYC/KYB Sharing
      POST
    • inquiry onboard status
      GET
    • get price
      POST
    • Create order
      POST
    • order list
      GET
    • inquiry single order
      GET
    • get user deposit address
      GET
    • get payment instruction
      GET
    • sync fund notification
      POST
  • Appendix
    • Enum
    • Virtual Account(VA) Support List & KYB requirement
  • Release Notes & Changelog
    • Version History
  1. Partner Flow

KYC/KYB Sharing

POST
/api/v1/onboarding/kyc-share

Request

Authorization
API Key
Add parameter in header
X-BPN-API-KEY
Example:
X-BPN-API-KEY: ********************
API Key
Add parameter in header
X-BPN-SIGNATURE
Example:
X-BPN-SIGNATURE: ********************
API Key
Add parameter in header
X-BPN-TIMESTAMP
Example:
X-BPN-TIMESTAMP: ********************
or
Body Params application/jsonRequired

Example
{
    "request_id": "string",
    "partner_user_id": "string",
    "customer_type": "INDIVIDUAL",
    "sharing_scenario": "ON_RAMP",
    "kyc_info": {
        "mobile_number": "string",
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "date_of_birth": "2019-08-24",
        "nationality": "HK",
        "id_type": "ID",
        "id_number": "string",
        "residential_address": {
            "line1": "string",
            "line2": "string",
            "city": "string",
            "region": "string",
            "postal_code": "string",
            "country": "string",
            "full_address": "string"
        },
        "account_purpose": "string",
        "occupation": "string"
    },
    "kyb_info": {
        "entity_details": {
            "business_name_en": "string",
            "business_name_zh": "string",
            "registered_business_number": "string",
            "certificate_of_incorporation_number": "string",
            "place_of_incorporation": "string",
            "registered_country_region": "string",
            "business_type": "string",
            "company_incorporation_date": "string",
            "registered_address": {
                "line1": "string",
                "line2": "string",
                "city": "string",
                "region": "string",
                "postal_code": "string",
                "country": "string",
                "full_address": "string"
            },
            "primary_operating_place": "string",
            "primary_operating_address": {
                "line1": "string",
                "line2": "string",
                "city": "string",
                "region": "string",
                "postal_code": "string",
                "country": "string",
                "full_address": "string"
            },
            "is_regulated_financial_institution": true,
            "is_listed_company": true,
            "is_government_owned_enterprise": true,
            "legal_entity_identifier": "string",
            "office_phone_number": "string",
            "email": "string"
        },
        "business_details": {
            "industry_nature_of_business": "string",
            "locations_of_business": "string",
            "industry_details": "string",
            "years_in_business": "string",
            "sales_turnover_previous_year": "string"
        },
        "financial_profile": {
            "initial_source_of_funds": "string",
            "place_of_source_of_funds": "string",
            "recurring_source_of_funds": "string",
            "estimated_total_net_assets_usd": "string",
            "estimated_net_liquid_assets_usd": "string"
        },
        "governance": {
            "board_meeting_quorum": "string"
        },
        "key_people": [
            {
                "roles": [
                    "string"
                ],
                "first_name_en": "string",
                "last_name_en": "string",
                "name_zh": "string",
                "email": "string",
                "mobile_number": "string",
                "residential_address": {
                    "line1": "string",
                    "line2": "string",
                    "city": "string",
                    "region": "string",
                    "postal_code": "string",
                    "country": "string",
                    "full_address": "string"
                },
                "id_issuing_country_region": "string",
                "id_type": "string",
                "id_number": "string",
                "is_director": true,
                "is_authorized_signatory": true,
                "is_ubo": true,
                "actual_owned_shares_percent": "string",
                "certified_id_document_refs": [
                    "string"
                ]
            }
        ],
        "super_administrator": {
            "first_name_en": "string",
            "last_name_en": "string",
            "name_zh": "string",
            "email": "string"
        },
        "amlq": {
            "questionnaire_completed": true,
            "questionnaire_version": "string",
            "completed_at": "string",
            "answers": [
                {
                    "property1": "string",
                    "property2": "string"
                }
            ]
        },
        "digital_wallet_opening_questions": {
            "purpose_of_account_opening": "string",
            "expected_business_counterparties": "string",
            "expected_monthly_transaction_volume": "string"
        }
    },
    "bank_account": {
        "account_holder_name": "string",
        "bank_name": "string",
        "bank_code": "string",
        "branch_code": "string",
        "account_number": "string",
        "currency": "HKD",
        "country": "HK",
        "account_type": "string",
        "proof_document_ref": "string"
    },
    "documents": [
        {
            "document_type": "string",
            "document_name": "string",
            "document_side": "string",
            "entity_role": "string",
            "holder_name": "string",
            "file_name": "string",
            "content_type": "string",
            "content_base64": "string",
            "sha256": "string",
            "issued_at": "2019-08-24",
            "expires_at": "2019-08-24",
            "certified_true_copy": true,
            "remark": "string"
        }
    ],
    "callback_url": "string"
}

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 '/api/v1/onboarding/kyc-share' \
--header 'X-BPN-API-KEY: <api-key>' \
--header 'X-BPN-SIGNATURE: <api-key>' \
--header 'X-BPN-TIMESTAMP: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "request_id": "string",
    "partner_user_id": "string",
    "customer_type": "INDIVIDUAL",
    "sharing_scenario": "ON_RAMP",
    "kyc_info": {
        "mobile_number": "string",
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "date_of_birth": "2019-08-24",
        "nationality": "HK",
        "id_type": "ID",
        "id_number": "string",
        "residential_address": {
            "line1": "string",
            "line2": "string",
            "city": "string",
            "region": "string",
            "postal_code": "string",
            "country": "string",
            "full_address": "string"
        },
        "account_purpose": "string",
        "occupation": "string"
    },
    "kyb_info": {
        "entity_details": {
            "business_name_en": "string",
            "business_name_zh": "string",
            "registered_business_number": "string",
            "certificate_of_incorporation_number": "string",
            "place_of_incorporation": "string",
            "registered_country_region": "string",
            "business_type": "string",
            "company_incorporation_date": "string",
            "registered_address": {
                "line1": "string",
                "line2": "string",
                "city": "string",
                "region": "string",
                "postal_code": "string",
                "country": "string",
                "full_address": "string"
            },
            "primary_operating_place": "string",
            "primary_operating_address": {
                "line1": "string",
                "line2": "string",
                "city": "string",
                "region": "string",
                "postal_code": "string",
                "country": "string",
                "full_address": "string"
            },
            "is_regulated_financial_institution": true,
            "is_listed_company": true,
            "is_government_owned_enterprise": true,
            "legal_entity_identifier": "string",
            "office_phone_number": "string",
            "email": "string"
        },
        "business_details": {
            "industry_nature_of_business": "string",
            "locations_of_business": "string",
            "industry_details": "string",
            "years_in_business": "string",
            "sales_turnover_previous_year": "string"
        },
        "financial_profile": {
            "initial_source_of_funds": "string",
            "place_of_source_of_funds": "string",
            "recurring_source_of_funds": "string",
            "estimated_total_net_assets_usd": "string",
            "estimated_net_liquid_assets_usd": "string"
        },
        "governance": {
            "board_meeting_quorum": "string"
        },
        "key_people": [
            {
                "roles": [
                    "string"
                ],
                "first_name_en": "string",
                "last_name_en": "string",
                "name_zh": "string",
                "email": "string",
                "mobile_number": "string",
                "residential_address": {
                    "line1": "string",
                    "line2": "string",
                    "city": "string",
                    "region": "string",
                    "postal_code": "string",
                    "country": "string",
                    "full_address": "string"
                },
                "id_issuing_country_region": "string",
                "id_type": "string",
                "id_number": "string",
                "is_director": true,
                "is_authorized_signatory": true,
                "is_ubo": true,
                "actual_owned_shares_percent": "string",
                "certified_id_document_refs": [
                    "string"
                ]
            }
        ],
        "super_administrator": {
            "first_name_en": "string",
            "last_name_en": "string",
            "name_zh": "string",
            "email": "string"
        },
        "amlq": {
            "questionnaire_completed": true,
            "questionnaire_version": "string",
            "completed_at": "string",
            "answers": [
                {
                    "property1": "string",
                    "property2": "string"
                }
            ]
        },
        "digital_wallet_opening_questions": {
            "purpose_of_account_opening": "string",
            "expected_business_counterparties": "string",
            "expected_monthly_transaction_volume": "string"
        }
    },
    "bank_account": {
        "account_holder_name": "string",
        "bank_name": "string",
        "bank_code": "string",
        "branch_code": "string",
        "account_number": "string",
        "currency": "HKD",
        "country": "HK",
        "account_type": "string",
        "proof_document_ref": "string"
    },
    "documents": [
        {
            "document_type": "string",
            "document_name": "string",
            "document_side": "string",
            "entity_role": "string",
            "holder_name": "string",
            "file_name": "string",
            "content_type": "string",
            "content_base64": "string",
            "sha256": "string",
            "issued_at": "2019-08-24",
            "expires_at": "2019-08-24",
            "certified_true_copy": true,
            "remark": "string"
        }
    ],
    "callback_url": "string"
}'

Responses

🟢200
application/json
统一响应信封
Bodyapplication/json

Example
{
    "code": "SUCCESS",
    "message": "ok",
    "data": {
        "bpn_user_id": "string",
        "customer_type": "INDIVIDUAL",
        "onboarding_status": "NOT_ONBOARDED"
    },
    "trace_id": "b7c1f0c2-3f0a-4e9b-9c2a-2b1d9d6f0a11"
}
Previous
inquiry supported currency
Next
inquiry onboard status
Built with