Manage Endpoint Compliance Requirements

These set of APIs allows you to manage the KYC (know your customer) and compliance requirements of a number / sender ID.

List Workspace Endpoint Compliance Requirements

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

Path parameters

workspaceId*string

endpointId*string

Query parameters

Response

200404

OK

Body

application/json

nextPageTokenstring

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

results*array of Numbers_EndpointComplianceRequirement (object)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/endpoints/{endpointId}/compliance-requirements', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "nextPageToken": "text",
  "results": [
    {
      "status": "satisfied",
      "mutable": false,
      "immutableReason": "managed",
      "message": "text",
      "evaluatedAt": "2024-11-21T09:13:22.685Z",
      "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",
          "status": "draft",
          "defaultLocale": "text",
          "questions": [
            {
              "locale": "text",
              "questions": [
                {
                  "type": "bool",
                  "key": "text",
                  "description": "text",
                  "placeholder": "text",
                  "displayName": "text",
                  "required": false,
                  "mapping": "text",
                  "format": "none",
                  "conditions": [
                    {
                      "key": "text",
                      "value": "text"
                    }
                  ],
                  "options": [
                    {
                      "key": "text",
                      "value": "text"
                    }
                  ],
                  "timezone": "text"
                }
              ]
            }
          ],
          "createdAt": "2024-11-21T09:13:22.685Z",
          "updatedAt": "2024-11-21T09:13:22.685Z"
        }
      ],
      "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": false
          }
        ],
        "reviewComment": "text",
        "createdAt": "2024-11-21T09:13:22.685Z",
        "displayName": "text",
        "tags": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "updatedAt": "2024-11-21T09:13:22.685Z"
      }
    }
  ]
}

Get Workspace Endpoint Compliance Requirement

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

Path parameters

workspaceId*string

endpointId*string

requirementName*string

Response

200404

OK

Body

application/json

Numbers_EndpointComplianceRequirement (object)

Numbers_EndpointComplianceRequirementKycForm (all of)Numbers_EndpointComplianceRequirementUseCase (all of)Numbers_EndpointComplianceRequirementZipwhipVerification (all of)Numbers_EndpointComplianceRequirementTenDlc (all of)Numbers_EndpointComplianceRequirementSMSOriginator (all of)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/endpoints/{endpointId}/compliance-requirements/{requirementName}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "status": "satisfied",
  "mutable": false,
  "immutableReason": "managed",
  "message": "text",
  "evaluatedAt": "2024-11-21T09:13:22.685Z",
  "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",
      "status": "draft",
      "defaultLocale": "text",
      "questions": [
        {
          "locale": "text",
          "questions": [
            {
              "type": "bool",
              "key": "text",
              "description": "text",
              "placeholder": "text",
              "displayName": "text",
              "required": false,
              "mapping": "text",
              "format": "none",
              "conditions": [
                {
                  "key": "text",
                  "value": "text"
                }
              ],
              "options": [
                {
                  "key": "text",
                  "value": "text"
                }
              ],
              "timezone": "text"
            }
          ]
        }
      ],
      "createdAt": "2024-11-21T09:13:22.685Z",
      "updatedAt": "2024-11-21T09:13:22.685Z"
    }
  ],
  "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": false
      }
    ],
    "reviewComment": "text",
    "createdAt": "2024-11-21T09:13:22.685Z",
    "displayName": "text",
    "tags": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "updatedAt": "2024-11-21T09:13:22.685Z"
  }
}

Update Workspace Endpoint Compliance Requirement

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

Path parameters

workspaceId*string

endpointId*string

requirementName*string

Body

application/json

Numbers_UpdateEndpointComplianceRequirementRequest (object)

Numbers_EndpointComplianceRequirementKycFormInputRequest (all of)Numbers_EndpointComplianceRequirementUseCaseInputRequest (all of)Numbers_EndpointComplianceRequirementTenDlcInputRequest (all of)

Response

200403404422

OK

Body

application/json

Numbers_EndpointComplianceRequirement (object)

Numbers_EndpointComplianceRequirementKycForm (all of)Numbers_EndpointComplianceRequirementUseCase (all of)Numbers_EndpointComplianceRequirementZipwhipVerification (all of)Numbers_EndpointComplianceRequirementTenDlc (all of)Numbers_EndpointComplianceRequirementSMSOriginator (all of)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/endpoints/{endpointId}/compliance-requirements/{requirementName}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "kyc-form"
    }),
});
const data = await response.json();

Response

200403404422

{
  "status": "satisfied",
  "mutable": false,
  "immutableReason": "managed",
  "message": "text",
  "evaluatedAt": "2024-11-21T09:13:22.685Z",
  "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",
      "status": "draft",
      "defaultLocale": "text",
      "questions": [
        {
          "locale": "text",
          "questions": [
            {
              "type": "bool",
              "key": "text",
              "description": "text",
              "placeholder": "text",
              "displayName": "text",
              "required": false,
              "mapping": "text",
              "format": "none",
              "conditions": [
                {
                  "key": "text",
                  "value": "text"
                }
              ],
              "options": [
                {
                  "key": "text",
                  "value": "text"
                }
              ],
              "timezone": "text"
            }
          ]
        }
      ],
      "createdAt": "2024-11-21T09:13:22.685Z",
      "updatedAt": "2024-11-21T09:13:22.685Z"
    }
  ],
  "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": false
      }
    ],
    "reviewComment": "text",
    "createdAt": "2024-11-21T09:13:22.685Z",
    "displayName": "text",
    "tags": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "updatedAt": "2024-11-21T09:13:22.685Z"
  }
}

Delete Workspace Endpoint Compliance Requirement

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

Path parameters

workspaceId*string

endpointId*string

requirementName*string

Response

200403404

OK

Body

application/json

Numbers_EndpointComplianceRequirement (object)

Numbers_EndpointComplianceRequirementKycForm (all of)Numbers_EndpointComplianceRequirementUseCase (all of)Numbers_EndpointComplianceRequirementZipwhipVerification (all of)Numbers_EndpointComplianceRequirementTenDlc (all of)Numbers_EndpointComplianceRequirementSMSOriginator (all of)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/endpoints/{endpointId}/compliance-requirements/{requirementName}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200403404

{
  "status": "satisfied",
  "mutable": false,
  "immutableReason": "managed",
  "message": "text",
  "evaluatedAt": "2024-11-21T09:13:22.685Z",
  "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",
      "status": "draft",
      "defaultLocale": "text",
      "questions": [
        {
          "locale": "text",
          "questions": [
            {
              "type": "bool",
              "key": "text",
              "description": "text",
              "placeholder": "text",
              "displayName": "text",
              "required": false,
              "mapping": "text",
              "format": "none",
              "conditions": [
                {
                  "key": "text",
                  "value": "text"
                }
              ],
              "options": [
                {
                  "key": "text",
                  "value": "text"
                }
              ],
              "timezone": "text"
            }
          ]
        }
      ],
      "createdAt": "2024-11-21T09:13:22.685Z",
      "updatedAt": "2024-11-21T09:13:22.685Z"
    }
  ],
  "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": false
      }
    ],
    "reviewComment": "text",
    "createdAt": "2024-11-21T09:13:22.685Z",
    "displayName": "text",
    "tags": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "updatedAt": "2024-11-21T09:13:22.685Z"
  }
}