API Docs

Retrieve a business profile

Retrieves the details of a specific business profile. 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.

Path parameters

Parameter	Type	Required	Description
`profileId`	string	Required	The `profile_id` of the business profile to retrieve (for example `MBP-00001`).

Response

Status code: 200 OK

Returns the business profile.

Response body fields

Field	Type	Source	Description
`id`	string (UUID)	System Provided	Primary identifier for the business profile record. Assigned at claim.
`org_id`	string (UUID)	System Provided	Organization that owns this business profile.
`profile_id`	string	System Provided	Human-readable business profile identifier (for example `MBP-00001`). Use as `business_profile_id` in document API paths.
`status`	string	System Provided	Onboarding lifecycle status (for example `ONBOARDED`, `LINKED`, `COMPLETED`).
`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. Present when VAT details are present in EmaraTax; omitted otherwise. 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 in `party_tax_scheme.company_id`.
`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`). See Get Electronic Address Schemes section for details.
`postal_address`	object	User Provided	UAE postal address. See postal_address below.

Registration vs VAT

Field	Meaning
`company_id`	Trade license or commercial registration number
`party_tax_scheme.company_id`	UAE VAT registration number (TRN) — 15-digit numeric identifier

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`). See Get UAE Subdivisions section for details.
`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`. See Get Countries section for details.

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`. See Get Tax Schemes section for details.

Conditional field rules

Condition	Affected fields	Rule
VAT registered in EmaraTax	`party_tax_scheme`	Object is present with TRN and `tax_scheme`. Omitted when VAT details are not present in EmaraTax.
`scheme_agency_id` is `TL`	`authority_name`	Present with the trade license issuing authority.
`scheme_agency_id` is `CD`	`authority_name`	Should be omitted.

Error responses

Status	Description
401 Unauthorized	Authentication required or invalid token.
403 Forbidden	User not authorized to access this business profile.
404 Not Found	Business profile not found.
500 Internal Server Error	An error occurred while processing the request.