WAwafeq
Connected Account

List

Changed on

Endpoint for retrieving a list of connected accounts.

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/

Request

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

Query parameters

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

Response

countinteger required

The total number of results across all pages.

nextstring uri nullable

The URL of the next page of results, or null on the last page.

previousstring uri nullable

The URL of the previous page of results, or null on the first page.

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

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