Getting Started

[B2C Client] Create Subaccount

Request Header

ReadMe parameters block:


Code
{
  "data": {
    "h-0": "Key Parameters",
    "h-1": "Data Type",
    "h-2": "Description",
    "0-0": "publicAccessToken",
    "0-1": "String",
    "0-2": "One time access-token generated using [this API](https://docs.onebrick.io/reference/generate-public-access-token-jwt-token)",
    "1-0": "X-Signature",
    "1-1": "String",
    "1-2": "A HMAC-SHA512 signature generated using your API secret. This is used to verify the integrity and authenticity of the request. The signature is created based on the request payload and the X-Timestamp.",
    "2-0": "X-Timestamp",
    "2-1": "DateTime",
    "2-2": "The timestamp of the request in ISO 8601 format. This is used to validate the freshness of the request. Format: `YYYY-MM-DDTHH:MM:SS.SSS±HH:MM`  \nExample: `2025-05-27T10:17:54.964+07:00`"
  },
  "cols": 3,
  "rows": 3,
  "align": [
    "left",
    "left",
    "left"
  ]
}

Request query parameters

Key Parameters	Data Type	Description
name	String	The name of the business or individual consumer
subAccountCode	String	A unique alphanumeric code (max. 5 characters) used to identify the subaccount
email	String	Contact email address for the subaccount
address	String	Business or residential address associated with the subaccount
picture	File	(Optional) Logo image file (max. 2 MB) to visually represent the subaccount

Response parameters

Key Parameters	Data Type	Description
status	String	Status of the subaccount creation: "approved" or "rejected"
apiKey	Object	Object containing the generated API credentials
clientKey	String	Encrypted public API key (using Client's public key uploaded via the upload public key API) for the subaccount.
clientSecret	String	Encrypted secret key (using Client's public key uploaded via the upload public key API) used to authenticate API requests

Error Response

Please check the B2C Subaccount Onboarding Product Documentation for the error response

Last modified on June 2, 2026

[B2C Client] Setup Public Key [B2C Client] Regenerate API Key

Getting Started

[B2C Client] Create Subaccount

Request Header

ReadMe parameters block:


Code
{
  "data": {
    "h-0": "Key Parameters",
    "h-1": "Data Type",
    "h-2": "Description",
    "0-0": "publicAccessToken",
    "0-1": "String",
    "0-2": "One time access-token generated using [this API](https://docs.onebrick.io/reference/generate-public-access-token-jwt-token)",
    "1-0": "X-Signature",
    "1-1": "String",
    "1-2": "A HMAC-SHA512 signature generated using your API secret. This is used to verify the integrity and authenticity of the request. The signature is created based on the request payload and the X-Timestamp.",
    "2-0": "X-Timestamp",
    "2-1": "DateTime",
    "2-2": "The timestamp of the request in ISO 8601 format. This is used to validate the freshness of the request. Format: `YYYY-MM-DDTHH:MM:SS.SSS±HH:MM`  \nExample: `2025-05-27T10:17:54.964+07:00`"
  },
  "cols": 3,
  "rows": 3,
  "align": [
    "left",
    "left",
    "left"
  ]
}

Request query parameters

Key Parameters	Data Type	Description
name	String	The name of the business or individual consumer
subAccountCode	String	A unique alphanumeric code (max. 5 characters) used to identify the subaccount
email	String	Contact email address for the subaccount
address	String	Business or residential address associated with the subaccount
picture	File	(Optional) Logo image file (max. 2 MB) to visually represent the subaccount

Response parameters

Key Parameters	Data Type	Description
status	String	Status of the subaccount creation: "approved" or "rejected"
apiKey	Object	Object containing the generated API credentials
clientKey	String	Encrypted public API key (using Client's public key uploaded via the upload public key API) for the subaccount.
clientSecret	String	Encrypted secret key (using Client's public key uploaded via the upload public key API) used to authenticate API requests

Error Response

Please check the B2C Subaccount Onboarding Product Documentation for the error response

Last modified on June 2, 2026

[B2C Client] Setup Public Key [B2C Client] Regenerate API Key