API Reference

Account Created / Updated

Published when an account creation or update is successfully completed.

Event metadata

  • name: ONBOARDING
  • types:
    • onboarding.account.create
    • onboarding.account.update

Request body

FieldsData TypeDescription
event_idstringA unique ID for the event.
event_namestringEvent name.
event_typestringEvent type.
source_idstringAccount ID.
versionstringAPI Version number.
dataobjectSimilar account object from Retrieve Account associated with the event.

Notification example

{
    "version": "V1.5.2",
    "event_name": "ONBOARDING",
    "event_type": "onboarding.account.create",
    "event_id": "8a78af1e-de83-43a5-b177-ecbc6a8a9fc6",
    "source_id": "f5bb6498-552e-40a5-b14b-616aa04ac1c1",
    "data": {
        "account_id": "f5bb6498-552e-40a5-b14b-616aa04ac1c1",
        "email": "[email protected]",
        "account_name": "UQPAY PTE LTD.",
        "country": "US",
        "status": "PROCESSING",
      	"idv_status": "PENDING",
      	"verification_status": "APPROVED",
      	"review_reason": "No risk.",
        "entity_type": "COMPANY",
        "contact_details": {
            "email": "[email protected]",
            "phone": "+6588880000"
        },
        "business_details": {
            "legal_entity_name": "ソフトバンクインターナショナル株式会社",
            "legal_entity_name_english": "UQPAY PTE LTD.",
            "incorporation_date": "2013-04-15",
            "registration_number": "201901754K",
            "business_structure": "SOLE_PROPRIETOR",
            "product_description": "Design and produce high-tech wireless headphones.",
            "merchant_category_code": "5733",
            "estimated_worker_count": "BS001",
            "monthly_estimated_revenue": {
                "amount": "TM001",
                "currency": "SGD"
            },
            "account_purpose": [
                "COLLECTION",
                "PAYOUT"
            ],
            "identifier": {
                "type": "VAT",
                "number": "XXX-XX-XXXX"
            },
            "website_url": "https://yourcompany.com"
        },
        "registration_address": {
            "city": "San Francisco",
            "line1": "9 N Buona Vista Dr",
            "state": "CA",
            "line2": "THE METROPOLIS",
            "postal_code": "94103"
        },
        "business_address": [
            {
                "city": "Singapore",
                "country": "SG",
                "line1": "9 N Buona Vista Dr",
                "state": "SG",
                "line2": "THE METROPOLIS",
                "postal_code": "138666"
            }
        ],
        "representatives": [
            {
                "roles": "DIRECTOR",
                "first_name": "Mock",
                "last_name": "Toy",
                "nationality": "SG",
                "date_of_birth": "2024-01-28",
                "share_percentage": "20.01",
                "identification": {
                    "type": "PASSPORT",
                    "id_number": "27738277K"
                },
                "residential_address": {
                    "city": "Singapore",
                    "country": "SG",
                    "line1": "9 N Buona Vista Dr",
                    "state": "SG",
                    "line2": "THE METROPOLIS",
                    "postal_code": "138666"
                },
                "as_applicant": false
            }
        ]
    }
}