Sign in

v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB
Accounts

Retrieve Account

Retrieves the details of an account.

get/v1/accounts/{id}

Path parameters

idstring uuid required
Example:b3d9d2d5-4c12-4946-a09d-953e82sed2b0

Universally unique identifier (UUID v4) of a resource.

Query parameters

business_code'BANKING' | 'ACQUIRING' | 'ISSUING'

Business type code. Default to BANKING.

Response

OK - Successfully retrieved an account details.

OR

Example response

{
  "account_id": "f5bb6498-552e-40a5-b14b-616aa04ac1c1",
  "short_reference_id": "P220406-LLCVLRM",
  "business_code": [
    "BANKING"
  ],
  "email": "example@company.com",
  "account_name": "UQPAY PTE LTD.",
  "country": "SG",
  "status": "PROCESSING",
  "verification_status": "UNDER_REVIEW",
  "review_reason": "The account is not compliant with the company's policies.",
  "contact_details": {
    "email": "example@company.com",
    "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": [
      "PAYOUT"
    ],
    "identifier": {
      "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": [
    {
      "country_code": "SG",
      "city": "Singapore",
      "street": "444 Orchard Rd, Midpoint Orchard, Singapore ",
      "postcode": "924011"
    }
  ],
  "representatives": [
    {
      "representative_id": "72970a7c-7921-431c-b95f-3438724ba16f",
      "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",
        "documents": {
          "front": "https://files.uqpaytech.com/api/v1/files/f715f7e6-eef8-49de-b333-d95847d9e130/20241105/WX20231213-141835@2x.png",
          "back": "https://files.uqpaytech.com/api/v1/files/f715f7e6-eef8-49de-b333-d95847d9e130/20241105/WX20231213-141835@2x.png"
        }
      },
      "residential_address": {
        "country_code": "SG",
        "city": "Singapore",
        "street": "444 Orchard Rd, Midpoint Orchard, Singapore ",
        "postcode": "924011"
      },
      "other_doucments": [
        {
          "type": "PROOF_OF_ADDRESS",
          "front": "b3d9d2d5-4c12-4946-a09d-953e82sed2b0"
        }
      ]
    }
  ],
  "documents": [
    {
      "type": "CERTIFICATE_OF_INCORPORATION",
      "front": "https://files.uqpaytech.com/api/v1/files/f715f7e6-eef8-49de-b333-d95847d9e130/20241105/WX20231213-141835@2x.png",
      "back": "https://files.uqpaytech.com/api/v1/files/f715f7e6-eef8-49de-b333-d95847d9e130/20241105/WX20231213-141835@2x.png"
    }
  ],
  "tos_acceptance": {
    "ip": "127.0.0.1",
    "date": "2024-03-22T16:08:02+08:00",
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0"
  }
}