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

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": []
}

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)

anyNumbers_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

403404422

{
  "code": "text",
  "message": "text"
}

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)

anyNumbers_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

403404

{
  "code": "text",
  "message": "text"
}