Skip to main content
GET
/
requirement_types
/
{id}
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const requirementType = await client.requirementTypes.retrieve('a38c217a-8019-48f8-bff6-0fdd9939075b');

console.log(requirementType.data);
{
  "data": {
    "acceptance_criteria": {
      "time_limit": "Current and not expired",
      "locality_limit": "Issued by the same country that the phone number belongs to",
      "acceptable_values": [
        "US"
      ],
      "max_length": 20,
      "min_length": 16,
      "acceptable_characters": "abcdef0123456789"
    },
    "description": "Proves the customer has a physical address in the same locality as the phone number",
    "example": "Utility bill, internet bill, phone bill, or lease",
    "type": "document",
    "name": "Proof of Address",
    "record_type": "requirement_type",
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "created_at": "2021-04-09T22:25:27.521Z",
    "updated_at": "2021-04-12T20:20:20.020Z"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Uniquely identifies the requirement_type record

Response

Successful response

data
object