Retrieve a document requirement
Retrieve a document requirement record
GET
/
requirements
/
{id}
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const requirement = await client.requirements.retrieve('a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaa');
console.log(requirement.data);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
requirement = client.requirements.retrieve(
"a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaa",
)
print(requirement.data)package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
requirement, err := client.Requirements.Get(context.TODO(), "a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaa")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", requirement.Data)
}package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.requirements.RequirementRetrieveParams;
import com.telnyx.sdk.models.requirements.RequirementRetrieveResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
RequirementRetrieveResponse requirement = client.requirements().retrieve("a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaa");
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
requirement = telnyx.requirements.retrieve("a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaa")
puts(requirement)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$requirement = $client->requirements->retrieve(
'a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaa'
);
var_dump($requirement);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx requirements retrieve \
--api-key 'My API Key' \
--id a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaacurl --request GET \
--url https://api.telnyx.com/v2/requirements/{id} \
--header 'Authorization: Bearer <token>'{
"data": {
"record_type": "requirement",
"country_code": "FR",
"locality": "Nice",
"phone_number_type": "local",
"action": "ordering",
"requirements_types": [
{
"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"
}
],
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"created_at": "2021-04-09T22:25:27.521Z",
"updated_at": "2021-04-12T20:20:20.020Z"
}
}{
"errors": [
{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>"
},
"meta": {}
}
]
}{
"errors": [
{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>"
},
"meta": {}
}
]
}Was this page helpful?
⌘I
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const requirement = await client.requirements.retrieve('a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaa');
console.log(requirement.data);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
requirement = client.requirements.retrieve(
"a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaa",
)
print(requirement.data)package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
requirement, err := client.Requirements.Get(context.TODO(), "a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaa")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", requirement.Data)
}package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.requirements.RequirementRetrieveParams;
import com.telnyx.sdk.models.requirements.RequirementRetrieveResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
RequirementRetrieveResponse requirement = client.requirements().retrieve("a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaa");
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
requirement = telnyx.requirements.retrieve("a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaa")
puts(requirement)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$requirement = $client->requirements->retrieve(
'a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaa'
);
var_dump($requirement);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx requirements retrieve \
--api-key 'My API Key' \
--id a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaacurl --request GET \
--url https://api.telnyx.com/v2/requirements/{id} \
--header 'Authorization: Bearer <token>'{
"data": {
"record_type": "requirement",
"country_code": "FR",
"locality": "Nice",
"phone_number_type": "local",
"action": "ordering",
"requirements_types": [
{
"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"
}
],
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"created_at": "2021-04-09T22:25:27.521Z",
"updated_at": "2021-04-12T20:20:20.020Z"
}
}{
"errors": [
{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>"
},
"meta": {}
}
]
}{
"errors": [
{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>"
},
"meta": {}
}
]
}