STstraitsx

Create a customer profile subprofile

[Available in Sandbox/Production environment] Create a subprofile for a customer profile. Subprofiles represent individual branches/outlets under a single UEN.

post/{customer_profile_id}/subprofiles

Request

  • Base URL
    https://api-sandbox.straitsx.com/v1/customer_profile
  • URL
    https://api-sandbox.straitsx.com/v1/customer_profile/{customer_profile_id}/subprofiles
  • Auth
    none required

Path parameters

customer_profile_idstring required

Customer Profile ID is retrieved from the response id of Create Customer Profile API<br>Regex: /^\s*.{1,191}\s*$/

Headers

X-XFERS-APP-API-KEYstring required

You can retrieve this from your Dashboard Developer Tools.<br><br><strong>Note:</strong> The X-XFERS-APP-API-KEY is a mandatory header for all authentication methods, including standard API key usage and HTTP Request Signing mode.

X-PUBLIC-KEY-IDstring

The Key ID, can be retrieved from your StraitsX Dashboard.<br><br><strong>Note:</strong> This header attribute is required when HTTP Request Signing is enabled for your account.

X-TIMESTAMPstring

Current Unix epoch time in seconds. Must be within ±300 seconds of server time.<br><br><strong>Note:</strong> This header attribute is required when HTTP Request Signing is enabled for your account.

X-NONCEstring

A unique UUID string per request, used for replay protection. Must not be reused within the timestamp window.<br>Regex: /\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/i<br><br><strong>Note:</strong> This header attribute is required when HTTP Request Signing is enabled for your account.

X-SIGNATUREstring

Base64-encoded digital signature of the canonical request string.<br><br><strong>Note:</strong> This header attribute is required when HTTP Request Signing is enabled for your account.

Request body

Example request

{
  "data": {
    "attributes": {
      "referenceId": "branch_orchard_001",
      "tradingName": "McDonald's Orchard",
      "address": {
        "street": "123 Orchard Road 01-01",
        "city": "Singapore",
        "state": "Singapore",
        "postalCode": "238858",
        "country": "SG"
      }
    }
  }
}

Response

200 - Existing subprofile returned (idempotent match on referenceId)

Example response

{
  "data": {
    "type": "subprofile",
    "id": "subprofile_xxx",
    "attributes": {
      "referenceId": "branch_orchard_001",
      "tradingName": "McDonald's Orchard",
      "address": {
        "street": "123 Orchard Road 01-01",
        "city": "Singapore",
        "state": "Singapore",
        "postalCode": "238858",
        "country": "SG"
      },
      "status": "pending",
      "createdAt": "2026-05-25T10:00:00Z",
      "updatedAt": "2026-05-25T10:00:00Z"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.