WAwafeq
Connected Account

Retrieve

Changed on

Endpoint for retrieving a single connected account.

Connected accounts should be used only for Platforms and White Label integrations that onboard customers and report documents on their behalf. Omit the X-ZATCA-Connected-Account-Id header when registering devices or reporting documents for your own organization. See the Platforms and White Label guide.

get/zatca/connected-accounts/{id}/

Request

  • Base URL
    https://api.wafeq.com/v1
  • URL
    https://api.wafeq.com/v1/zatca/connected-accounts/{id}/
  • Auth
    API key in header Authorization

Path parameters

idstring required

A unique value identifying this connected account.

Response

addressstring required

The street address of the account

business_categorystring required

The business category or industry of this account

citystring required

The city of the account

countrystring required

The alpha-2 code of the country (ISO 3166-1)

idstring required

The id of the object

namestring required

The account name

tax_registration_numberstring required

The tax registration number for this account

Changes

  • 6b4a622bbb4fRevision changes
    • breaking

      the response property's maxLength was unset from 255 for the response status

    • breaking

      the response property's maxLength was unset from 200 for the response status

    • breaking

      the response property's maxLength was unset from 200 for the response status

    • breaking

      the response property's maxLength was unset from 255 for the response status

    • breaking

      the response property's maxLength was unset from 15 for the response status

    • breaking

      the response property's minLength was decreased from 15 to 0 for the response status

    • breaking

      the response's property type changed from no type to string for status

    • info

      the response optional property became read-only for the status

    • info

      removed from the response property allOf list for the response status

    • info

      the response property became required for the status

    • info

      the response required property became read-only for the status

    • info

      the response required property became read-only for the status

    • info

      the response required property became read-only for the status

    • info

      the response required property became read-only for the status

    • info

      the response required property became read-only for the status