Account

Create a workspace

Create workspace from the submitted fields.

POST/v1/workspaces

Body parameters

application/json · required
name string required

Display name of the resource.

Minimum length: 1 character. · Maximum length: 255 characters.

ExampleAcme workspace
country string required

country for this workspace.

Minimum length: 1 character. · Maximum length: 255 characters.

ExampleSA
email string required

Email address associated with the identity.

Must be present and may be null.

Maximum length: 255 characters.

Exampleowner@example.com
phone string required

phone for this workspace.

Must be present and may be null.

Maximum length: 255 characters.

Example+966500000000
officialName string required

official name for this workspace.

Must be present and may be null.

Maximum length: 255 characters.

ExampleConsulting services
tradeName string required

trade name for this workspace.

Must be present and may be null.

Maximum length: 255 characters.

ExampleConsulting services
registrationNumber string required

registration number for this workspace.

Must be present and may be null.

Maximum length: 255 characters.

ExampleCR-0001234567
taxId string required

ID of the related tax.

Must be present and may be null.

Maximum length: 255 characters.

Example100.00
city string required

city for this workspace.

Must be present and may be null.

Maximum length: 255 characters.

ExampleRiyadh
address string required

address for this workspace.

Must be present and may be null.

Maximum length: 255 characters.

ExampleKing Fahd Road
state string required

Current state of the record or operation.

Must be present and may be null.

Maximum length: 255 characters.

ExampleRiyadh
zip string required

zip for this workspace.

Must be present and may be null.

Maximum length: 255 characters.

ExampleConsulting services
currencyCode string required

currency code for this workspace.

Minimum length: 1 character. · Maximum length: 255 characters.

ExampleSAR
payables object[] nullable

payables for this workspace.

ShowHide 6 properties
payables[].name string required

Display name of the resource.

Minimum length: 1 character. · Maximum length: 255 characters.

ExampleAcme workspace
payables[].recipient string required

recipient within payables.

Minimum length: 1 character. · Maximum length: 255 characters.

ExampleConsulting services
payables[].recipientType string required

recipient type within payables.

Allowed values: "company", "individual", "government"

Examplecompany
payables[].kind string required

kind within payables.

Allowed values: "percentage", "fixed"

Examplepercentage
payables[].value string required

Value returned by the operation.

Minimum length: 1 character. · Maximum length: 128 characters.

Example100.00
payables[].purpose string required

purpose within payables.

Allowed values: "vat", "zakah", "custom"

Examplevat
bank object required

bank for this workspace.

ShowHide 5 properties
bank.label string required

Human-readable label for the value.

Minimum length: 1 character. · Maximum length: 255 characters.

ExampleOperating account
bank.bankName string required

bank name within bank.

Minimum length: 1 character. · Maximum length: 255 characters.

ExampleNQD Bank
bank.accountName string required

account name within bank.

Minimum length: 1 character. · Maximum length: 255 characters.

ExampleOperating account
bank.accountNumber string required

account number within bank.

Minimum length: 1 character. · Maximum length: 255 characters.

ExampleConsulting services
bank.iban string required

iban within bank.

ExampleSA0380000000608010167519
banks object[] nullable

banks for this workspace.

ShowHide 5 properties
banks[].label string required

Human-readable label for the value.

Minimum length: 1 character. · Maximum length: 255 characters.

ExampleOperating account
banks[].bankName string required

bank name within banks.

Minimum length: 1 character. · Maximum length: 255 characters.

ExampleNQD Bank
banks[].accountName string required

account name within banks.

Minimum length: 1 character. · Maximum length: 255 characters.

ExampleOperating account
banks[].accountNumber string required

account number within banks.

Minimum length: 1 character. · Maximum length: 255 characters.

ExampleConsulting services
banks[].iban string required

iban within banks.

ExampleSA0380000000608010167519
fiscalStart string required

fiscal start for this workspace.

Must be present and may be null.

Example2026-01-01
submissionId string required

ID of the related submission.

Minimum length: 1 character. · Maximum length: 255 characters.

Example550e8400-e29b-41d4-a716-446655440000

Headers

authorization string required

Bearer access token returned by the authentication service.

ExampleBearer $NQD_ACCESS_TOKEN

This operation does not use a workspace scope.

Response

201Success

Response headers

x-request-id string

Correlation identifier returned with every response for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000
data object

Returned records. Collections and batches use an array; single records use an object.

ShowHide 1 property
data.workspaceId string

ID of the workspace that owns the resource.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1A

Possible errors

400 Invalid request

Response headers

x-request-id string

Correlation identifier returned with every response for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000
error object

Error details returned for a failed request.

ShowHide 4 properties
error.code string

Stable machine-readable error or resource code.

Exampleinvalid_input
error.message string

Human-readable explanation of the result or error.

ExampleThe request could not be validated.
error.requestId string

Correlation identifier for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000
error.details object nullable

Additional structured details about the result or error.

ShowHide 1 property
error.details.issues object[]

Structured field issues returned when request validation fails.

ShowHide 3 properties
error.details.issues[].path string | number[]

Field path where the validation issue occurred.

One of: string alternative 1, number alternative 2

Example0 items
error.details.issues[].reason string

Machine-readable reason for the validation issue.

Allowed values: "expected_type", "required", "unexpected_property", "invalid_value", "invalid_json", "invalid_query", "unsupported_media_type", "body_too_large", "body_timeout", "conflicting_scope", "missing_header", "concurrency_required", "invalid_resource_id", "invalid_request"

Exampleinvalid_request
error.details.issues[].code string nullable

Stable machine-readable error or resource code.

Exampleinvalid_input
Example 400 response
{
  "error": {
    "code": "invalid_input",
    "message": "The request could not be validated.",
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "details": {
      "issues": [
        {
          "path": [],
          "reason": "invalid_request"
        }
      ]
    }
  }
}
View raw OpenAPI operation

Use the machine-readable contract for client generation and payload validation.

Open OpenAPI contract ↗