Skip to main content
WEBHOOK
accountStatus
{
  "version": "V1.6.0",
  "event_name": "ONBOARDING",
  "event_type": "onboarding.account.create",
  "event_id": "378fb2d2-83c1-457f-8c5c-67e278f988ee",
  "source_id": "fe33188c-954c-4a6b-8c6b-9fce08930ce9",
  "data": {
    "account_id": "fe33188c-954c-4a6b-8c6b-9fce08930ce9",
    "account_name": "SUB UQPAY PTE LTD",
    "short_reference_id": "CB6664676352",
    "direct_id": "b1b89684-c2c4-4d54-b8a8-3572727fd120",
    "email": "defmo@exam1ple.com",
    "country": "SG",
    "entity_type": "COMPANY",
    "status": "PROCESSING",
    "idv_status": "",
    "verification_status": "PENDING",
    "review_reason": "",
    "contact_details": {
      "email": "email@uqpay.com",
      "phone": "+1 2345678"
    },
    "business_details": {
      "legal_entity_name": "SUB UQPAY PTE LTD",
      "legal_entity_name_english": "SUB UQPAY PTE LTD",
      "business_structure": "LIMITED_COMPANY",
      "incorporation_date": "2020-01-01",
      "registration_number": "123456789",
      "merchant_category_code": "0742",
      "product_description": "description",
      "website_url": "https://www.uqpay.com",
      "estimated_worker_count": "BS002",
      "issuing_countries": [
        "USD",
        "EUR",
        "SGD"
      ],
      "monthly_estimated_revenue": {
        "amount": "TM003",
        "currency": "USD,EUR,SGD"
      },
      "identifier": {
        "type": "VAT",
        "number": "SG123456789"
      }
    },
    "registration_address": {
      "city": "city",
      "line1": "123 Innovation Drive",
      "line2": "Suite 100",
      "state": "ST",
      "postal_code": "94105"
    },
    "business_address": [
      {
        "city": "city",
        "country": "SG",
        "line1": "123 Innovation Drive",
        "line2": "",
        "state": "ST",
        "postal_code": "94105"
      }
    ],
    "representatives": [
      {
        "representative_id": "3b93d8f9-8452-4e40-a0c2-44fc8fd8daa5",
        "first_name": "San",
        "last_name": "Zhang",
        "nationality": "SG",
        "date_of_birth": "1980-05-20",
        "email_address": "c123@qq.com",
        "as_applicant": true,
        "roles": "DIRECTOR",
        "share_percentage": "0.00",
        "identification": {
          "type": "PASSPORT",
          "id_number": "A12345678",
          "documents": {
            "front": "https://sg-identity-bucket-sandbox.s3.ap-southeast-1.amazonaws.com/account/CB6664676352/20260423/395287e827124e3ba0ca7bea8544051b.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAYVXMOJZED27RASBZ%2F20260423%2Fap-southeast-1%2Fs3%2Faws4_request&X-Amz-Date=20260423T140352Z&X-Amz-Expires=43200&X-Amz-SignedHeaders=host&x-id=GetObject&X-Amz-Signature=3dcb60ab7d283f8cceb44b9b004585fd3e9b6a70890defd46062a72d5b24771c"
          }
        },
        "other_documents": null,
        "residential_address": {
          "city": "city",
          "country": "SG",
          "line1": "456 Elm Street",
          "line2": "Suite 100",
          "state": "ST",
          "postal_code": "94105"
        }
      },
      {
        "representative_id": "d09fbed8-14d7-43fe-a33f-8b2687433083",
        "first_name": "luca",
        "last_name": "Smith",
        "nationality": "US",
        "date_of_birth": "1980-05-20",
        "email_address": "c123@qq.com",
        "as_applicant": false,
        "roles": "BENEFICIAL_OWNER",
        "share_percentage": "15.50",
        "identification": {
          "type": "PASSPORT",
          "id_number": "A12345678",
          "documents": {
            "front": "https://sg-identity-bucket-sandbox.s3.ap-southeast-1.amazonaws.com/account/CB6664676352/20260423/c3c4cbb4cf984182a484630b8cb25f97.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAYVXMOJZED27RASBZ%2F20260423%2Fap-southeast-1%2Fs3%2Faws4_request&X-Amz-Date=20260423T140352Z&X-Amz-Expires=43200&X-Amz-SignedHeaders=host&x-id=GetObject&X-Amz-Signature=c6b8a2e6debe0550db19ad5e91335ea4cc30594cc2e04fb3b612ad5f32e4e17e"
          }
        },
        "other_documents": [
          {
            "type": "PROOF_OF_ADDRESS",
            "front": "https://sg-identity-bucket-sandbox.s3.ap-southeast-1.amazonaws.com/account/CB6664676352/20260423/dac1aa1b852e4a18967c9f5793e4bbd4.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAYVXMOJZED27RASBZ%2F20260423%2Fap-southeast-1%2Fs3%2Faws4_request&X-Amz-Date=20260423T140352Z&X-Amz-Expires=43200&X-Amz-SignedHeaders=host&x-id=GetObject&X-Amz-Signature=243941e4b83ff98294c06e5d1e8498a3e48319e6545207353f9319e226e31a9a"
          },
          {
            "type": "OTHERS",
            "front": "https://sg-identity-bucket-sandbox.s3.ap-southeast-1.amazonaws.com/account/CB6664676352/20260423/d1d54dca539d4deab2ddba35461106a3.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAYVXMOJZED27RASBZ%2F20260423%2Fap-southeast-1%2Fs3%2Faws4_request&X-Amz-Date=20260423T140352Z&X-Amz-Expires=43200&X-Amz-SignedHeaders=host&x-id=GetObject&X-Amz-Signature=d1ccc2d152093004e167b9e26708eb5c499f4921a44ea99237170921718840c4"
          }
        ],
        "residential_address": {
          "city": "San Francisco",
          "country": "US",
          "line1": "456 Elm Street",
          "line2": "Suite 100",
          "state": "CA",
          "postal_code": "94105"
        }
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers-sandbox.uqpaytech.com/llms.txt

Use this file to discover all available pages before exploring further.

Event Types

Event TypeDescription
onboarding.account.createA new account finished its initial onboarding flow.
onboarding.account.updateAn existing account’s onboarding data was updated — for example a status change, information correction, or verification outcome.
The data object mirrors the shape of the Retrieve Account API response.

Body

application/json
event_id
string<uuid>
required

A unique identifier for this event.

event_name
enum<string>
required

Top-level event category.

Available options:
ONBOARDING
event_type
enum<string>
required

The specific event type that occurred.

Available options:
onboarding.account.create,
onboarding.account.update
source_id
string
required

Account ID.

version
string
required

API version number.

Example:

"V1.6.0"

data
object

Account details associated with the event. Shape mirrors the response of the Retrieve Account API, with one caveat: on the onboarding.account.update event, document URLs and representative-level internal fields (documents, other_documents, representative_id, email_address, idv_status) are typically omitted because the update payload reflects the compliance-reviewed state rather than the applicant-submitted profile.

Response

200

Return 200 to acknowledge receipt.