API Docs

The Business Profile object

See the right panel for the complete object definition and code examples.

Attributes

Core fields

Core fields are all root-level attributes on the business profile. Nested fields (postal_address, party_tax_scheme) are linked to their respective tables below for full attribute details.

Field	Type	Required	Description
`id`	string	Required	Unique identifier for the business profile. Automatically generated when the profile is created.
`org_id`	string	Required	The organization ID that owns this business profile. Automatically set based on the authenticated organization.
`profile_id`	string	Required	Use this field when referencing the business profile in document creation (e.g. in `accounting_supplier_party.profile_id`).
`name`	string	Required	The business profile name or display name.
`party_name`	string	Required	The legal name of the business entity. This is the official name used in legal documents and tax registrations.
`party_name_in_local_language`	string	Optional	The party name in Arabic or local language.
`email`	string	Required	The business profile's email address. Used for notifications and communication.
`telephone`	string	Optional	The business profile's telephone number.
`logo_url`	string	Optional	URL to the business profile's logo image.
`scheme_agency_id`	string	Optional	Scheme agency identifier code (e.g. `EID`, `PAS`, `TL`, `CD`, `OTH`).
`company_id`	string	Optional	Commercial register or trade license identifier for the business profile.
`authority_name`	string	Optional	Name of the authority that issued or governs the registration details for this profile.
`tin`	string	Optional	Taxpayer Identification Number (TIN) for the business entity.
`endpoint_id`	string	Optional	Electronic endpoint identifier used for document exchange (e.g. PEPPOL endpoint/participant ID).
`endpoint_scheme_id`	string	Optional	Scheme identifier for the `endpoint_id` value.
`passport_issuing_country_code`	string	Optional	ISO 3166-1 alpha-2 country code of the passport issuing country, when applicable.
`status`	string	Optional	Current onboarding lifecycle status of the business profile (e.g. `ONBOARDED`, `COMPLETED`).
`created_by`	string (UUID)	Optional	UUID of the user who created this business profile record (`X-User-Id` context).
`updated_by`	string (UUID)	Optional	UUID of the user who last updated this business profile record (`X-User-Id` context).
`created_at`	number (int64)	Optional	Record creation timestamp stored as Unix time (`int64`).
`updated_at`	number (int64)	Optional	Record update timestamp stored as Unix time (`int64`).
`postal_address`	object	Required	The business profile's postal address. See Address object below.
`party_tax_scheme`	object	Required	Tax scheme information for the business profile. For nested attribute details, see the Party tax scheme object table below.

Address object

The postal_address field uses the address object structure.

Field	Type	Required	Description
`street_name`	string	Required	Street name or primary address line.
`additional_street_name`	string	Optional	Additional street details when provided.
`city_name`	string	Required	City or town name.
`postal_zone`	string	Optional	Postal or ZIP code.
`country_subentity`	string	Required	Region, state, or emirate code (e.g. `DXB` for Dubai). See Get UAE Subdivisions.
`address_line`	string	Optional	Additional address line if needed.
`country`	string	Required	Country name (e.g. `United Arab Emirates`).
`country_code`	string	Required	ISO 3166-1 alpha-2 country code (e.g. `AE`). See Get Countries.

Response-only fields (business profile `postal_address`)

These fields may appear on retrieved business profiles but are not part of the request address object:

Field	Type	Description
`id`	string (UUID)	Unique identifier of the persisted postal address record.
`created_at`	number (int64)	Address record creation timestamp (Unix time).
`updated_at`	number (int64)	Address record update timestamp (Unix time).

Party tax scheme object

The party_tax_scheme field is an object with the following attributes:

Field	Type	Required	Description
`company_id`	string	Required	The company or tax registration number.
`tax_scheme`	string	Required	Tax scheme identifier (e.g. `VAT` for Value Added Tax). See Get Tax Schemes.
`tax_scheme_id`	string	Optional	Scheme agency identifier when required by the tax authority.