Get Number Requirement

Get Number Compliance Requirement

GET/workspaces/{workspaceId}/numbers/{numberId}/compliance-requirements/{requirementName}

Path parameters

workspaceId*string

numberId*string

requirementName*string

Response

200404422

OK

Body

application/json

requirement*ComplianceRequirement (one of)

ComplianceKYCFormRequirement (all of)ComplianceUseCaseRequirement (all of)

status*ComplianceStatus (enum)

okpendingnot-validnot-founderrorno-reference

reference*nullable string

Request

JavaScriptCurl

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

Response

{
  "requirement": {
    "name": "text",
    "type": "kycForm",
    "scope": "number-activation",
    "selector": {
      "scope": "text",
      "numberType": "local",
      "countryCode": "AC"
    }
  },
  "status": "ok",
  "reference": "text"
}