List Workspace compliance Requirements

List Workspace Endpoint Compliance Requirements

get

List compliance requirements for a capability/destination. If no capability/destination is provided, all compliance requirements are returned. This result may be paginated. To learn more about the pagination, please refer to the pagination section on API Access Common API Usage section.

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

workspaceIdstring · uuidRequired

The ID for the workspace.

Example: d386a801-ee8d-4aba-a7e4-78671bd3b11e

endpointIdstringRequired

Your endpoint ID. In some cases (e.g. Long Code Numbers) this value is equal to the number ID.

Query parameters

capabilitystring · enumOptionalPossible values:

destinationstring · iso3166-1 · nullableOptional

Responses

200

OK

application/json

nextPageTokenstringOptional

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display. To know more, refer to the pagination section.

resultsone of[]Required

The compliance requirements associated to the endpoint that must be satisfied.

or

or

or

or

404

Endpoint not found

application/json

get

/workspaces/{workspaceId}/endpoints/{endpointId}/compliance-requirements

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/endpoints/{endpointId}/compliance-requirements HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

{
  "nextPageToken": "text",
  "results": [
    {
      "status": "satisfied",
      "mutable": true,
      "immutableReason": "managed",
      "message": "text",
      "evaluatedAt": "2026-03-26T19:11:30.187Z",
      "issues": [
        "subscription-is-not-active"
      ],
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "type": "kyc-form",
      "capabilities": [
        "voice"
      ],
      "destinations": [
        "text"
      ],
      "managedBy": "text",
      "appliesTo": "endpoint",
      "forms": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "scope": "number",
          "countryCode": "text",
          "conditions": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "status": "draft",
          "defaultLocale": "text",
          "questions": [
            {
              "locale": "text",
              "questions": [
                {
                  "type": "bool",
                  "key": "text",
                  "description": "text",
                  "placeholder": "text",
                  "displayName": "text",
                  "required": true,
                  "mapping": "text",
                  "format": "none",
                  "conditions": [
                    {
                      "key": "text",
                      "value": "text"
                    }
                  ],
                  "options": [
                    {
                      "key": "text",
                      "value": "text"
                    }
                  ],
                  "timezone": "text"
                }
              ]
            }
          ],
          "gracePeriodDays": 1,
          "createdAt": "2026-03-26T19:11:30.187Z",
          "updatedAt": "2026-03-26T19:11:30.187Z"
        }
      ],
      "formOptions": {
        "ANY_ADDITIONAL_PROPERTY": "123e4567-e89b-12d3-a456-426614174000"
      },
      "formId": "123e4567-e89b-12d3-a456-426614174000",
      "formEntryId": "123e4567-e89b-12d3-a456-426614174000",
      "formEntry": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "organizationId": "123e4567-e89b-12d3-a456-426614174000",
        "formId": "123e4567-e89b-12d3-a456-426614174000",
        "locale": "text",
        "status": "draft",
        "businessProfileId": "123e4567-e89b-12d3-a456-426614174000",
        "businessProfileVersion": 1,
        "answers": [
          {
            "key": "text",
            "valueString": "text",
            "isDefault": true
          }
        ],
        "reviewComment": "text",
        "createdAt": "2026-03-26T19:11:30.187Z",
        "displayName": "text",
        "tags": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "updatedAt": "2026-03-26T19:11:30.187Z"
      }
    }
  ]
}