API Docs

List business profiles

Retrieves a paginated list of business profiles. See the right panel for the base URL, request sample, and response JSON.

Rate limit

30 requests/minute per authenticated account. See Rate limiting for response headers (X-RateLimit-*) and retry guidance.

Query parameters

Parameter	Type	Required	Description
`name`	string	Optional	Filter by business profile name (partial match, case-insensitive).
`email`	string	Optional	Filter by business profile email address.
`status`	string	Optional	Filter by onboarding lifecycle status (for example `ONBOARDED`, `COMPLETED`).
`page`	integer	Optional	Page number (0-indexed). Default: `0`.
`page_size`	integer	Optional	Number of items per page. Default: `10`. Maximum: `100`.

Response

Status code: 200 OK

Returns a paginated response. Results are filtered based on user permissions.

Pagination fields

Field	Type	Source	Description
`content`	array	System Provided	Array of business profile objects. See Business profile item below.
`page_number`	integer	System Provided	Current page number (0-indexed).
`total_pages`	integer	System Provided	Total number of pages available.
`total_elements`	integer	System Provided	Total number of business profiles matching the filter.

Business profile item

Each item in content has the following fields:

Field	Type	Source	Description
`id`	string (UUID)	System Provided	Primary identifier for the business profile record.
`org_id`	string (UUID)	System Provided	Organization that owns this business profile.
`profile_id`	string	System Provided	Human-readable business profile identifier. Use as `business_profile_id` in document API paths.
`status`	string	System Provided	Onboarding lifecycle status.
`created_by`	string (UUID)	System Provided	User who created the profile record.
`updated_by`	string (UUID)	System Provided	User who last updated the profile record.
`created_at`	number	System Provided	Record creation timestamp (Unix time).
`updated_at`	number	System Provided	Record last-update timestamp (Unix time).
`party_tax_scheme`	object	System Provided	UAE VAT/TRN details from EmaraTax onboard. Omitted when VAT details are not present in EmaraTax. See party_tax_scheme below.
`name`	string	User Provided	Business profile display name.
`party_name`	string	User Provided	Legal name of the business entity.
`party_name_in_local_language`	string	User Provided	Party name in Arabic or local language.
`logo_url`	string	User Provided	URL to the business profile logo.
`email`	string	User Provided	Business contact email.
`telephone`	string	User Provided	Business telephone number.
`scheme_agency_id`	string	User Provided	Registration type (`TL` or `CD`). See Get Registration Types section for details.
`company_id`	string	User Provided	Trade license or registration number. Distinct from VAT/TRN.
`authority_name`	string	User Provided	Issuing authority for the trade license. Present when `scheme_agency_id` is `TL`.
`tin`	string	User Provided	TIN from EmaraTax.
`endpoint_id`	string	User Provided	Peppol electronic endpoint identifier.
`endpoint_scheme_id`	string	User Provided	Scheme for `endpoint_id` (typically `0235`).
`postal_address`	object	User Provided	UAE postal address. See postal_address below.

postal_address

Field	Type	Source	Description
`id`	string (UUID)	System Provided	Identifier of the persisted address record.
`street_name`	string	User Provided	Street name or primary address line.
`additional_street_name`	string	User Provided	Additional street details.
`city_name`	string	User Provided	City or town name.
`postal_zone`	string	User Provided	Postal or ZIP code.
`country_subentity`	string	User Provided	Emirate or region code (for example `DXB`).
`address_line`	string	User Provided	Additional address line.
`country`	string	User Provided	Country name.
`country_code`	string	User Provided	ISO 3166-1 alpha-2 country code. Must be `AE`.

party_tax_scheme

Field	Type	Source	Description
`company_id`	string	System Provided	UAE VAT registration number (TRN). 15 digits; starts with `1` and ends with `03`.
`tax_scheme`	string	System Provided	Tax scheme identifier. Typically `VAT`.

Conditional field rules

Condition	Affected fields	Rule
VAT registered in EmaraTax	`party_tax_scheme`	Object is present on each list item when VAT data is present. Omitted otherwise.
`scheme_agency_id` is `TL`	`authority_name`	Present on each item with the trade license issuing authority.

Error responses

Status	Description
400 Bad Request	Invalid request parameters or validation failed.
401 Unauthorized	Authentication required or invalid token.
500 Internal Server Error	An error occurred while processing the request.