List Workspace compliace Requirements

List Workspace Endpoint Compliance Requirements

get

Authorizations

MessageBird_userMessageBird_accessKey

Path parameters

workspaceIdstringRequired

endpointIdstringRequired

Query parameters

capabilitystring · enumOptionalAvailable options:

destinationstring · iso3166-1 | nullableOptional

Responses

application/json

all ofOptional

application/json

get

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/endpoints/{endpointId}/compliance-requirements HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "nextPageToken": "text",
  "results": [
    {
      "status": "satisfied",
      "mutable": true,
      "immutableReason": "managed",
      "message": "text",
      "evaluatedAt": "2025-04-22T19:56:03.270Z",
      "issues": [
        "subscription-is-not-active"
      ],
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "type": "kyc-form",
      "capabilities": [
        "voice"
      ],
      "destinations": [
        "text"
      ],
      "managedBy": "text",
      "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": "2025-04-22T19:56:03.270Z",
          "updatedAt": "2025-04-22T19:56:03.270Z"
        }
      ],
      "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",
        "answers": [
          {
            "key": "text",
            "valueString": "text",
            "isDefault": true
          }
        ],
        "reviewComment": "text",
        "createdAt": "2025-04-22T19:56:03.270Z",
        "displayName": "text",
        "tags": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "updatedAt": "2025-04-22T19:56:03.270Z"
      }
    }
  ]
}