Render a phone-number reputation Letter of Authorization
Render the LOA for this enterprise as a PDF. The enterprise identity, address, and authorized-representative contact are taken from the enterprise record; the optional agent block is supplied only when a third-party partner manages the numbers. The response is the PDF itself (unsigned unless a signature is provided). Sign it and upload it to the Telnyx Documents API (POST /v2/documents, see https://developers.telnyx.com/api/documents) to obtain the loa_document_id required by POST .../reputation.
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const response = await client.enterprises.reputation.loa.render(
'4a6192a4-573d-446d-b3ce-aff9117272a6',
);
console.log(response);
const content = await response.blob();
console.log(content);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
response = client.enterprises.reputation.loa.render(
enterprise_id="4a6192a4-573d-446d-b3ce-aff9117272a6",
)
print(response)
content = response.read()
print(content)
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"),
)
response, err := client.Enterprises.Reputation.Loa.Render(
context.TODO(),
"4a6192a4-573d-446d-b3ce-aff9117272a6",
telnyx.EnterpriseReputationLoaRenderParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.core.http.HttpResponse;
import com.telnyx.sdk.models.enterprises.reputation.loa.LoaRenderParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
HttpResponse response = client.enterprises().reputation().loa().render("4a6192a4-573d-446d-b3ce-aff9117272a6");
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
response = telnyx.enterprises.reputation.loa.render("4a6192a4-573d-446d-b3ce-aff9117272a6")
puts(response)<?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 {
$response = $client->enterprises->reputation->loa->render(
'4a6192a4-573d-446d-b3ce-aff9117272a6',
agent: [
'administrativeArea' => 'administrative_area',
'city' => 'city',
'contactEmail' => '[email protected]',
'contactName' => 'contact_name',
'contactPhone' => '+13125550000',
'contactTitle' => 'contact_title',
'country' => 'US',
'legalName' => 'legal_name',
'postalCode' => 'postal_code',
'streetAddress' => 'street_address',
'dba' => 'dba',
'extendedAddress' => 'extended_address',
],
signature: ['imageBase64' => 'image_base64', 'signerName' => 'signer_name'],
);
var_dump($response);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx enterprises:reputation:loa render \
--api-key 'My API Key' \
--enterprise-id 4a6192a4-573d-446d-b3ce-aff9117272a6curl --request POST \
--url https://api.telnyx.com/v2/enterprises/{enterprise_id}/reputation/loa \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'"<string>"Authorizations
Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
Path Parameters
The enterprise id. Lowercase UUID.
"4a6192a4-573d-446d-b3ce-aff9117272a6"
Body
All fields optional. The enterprise identity, address, and authorized-representative contact are read from the enterprise record keyed by the path parameter.
Third-party reseller / partner managing the enterprise's phone numbers. Omit when the enterprise works directly with Telnyx.
Show child attributes
Show child attributes
Optional signature embedded in the rendered PDF. When omitted the PDF is returned unsigned for the customer to sign and upload.
Show child attributes
Show child attributes
Response
Rendered LOA PDF.
The response is of type file.
Was this page helpful?
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const response = await client.enterprises.reputation.loa.render(
'4a6192a4-573d-446d-b3ce-aff9117272a6',
);
console.log(response);
const content = await response.blob();
console.log(content);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
response = client.enterprises.reputation.loa.render(
enterprise_id="4a6192a4-573d-446d-b3ce-aff9117272a6",
)
print(response)
content = response.read()
print(content)
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"),
)
response, err := client.Enterprises.Reputation.Loa.Render(
context.TODO(),
"4a6192a4-573d-446d-b3ce-aff9117272a6",
telnyx.EnterpriseReputationLoaRenderParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.core.http.HttpResponse;
import com.telnyx.sdk.models.enterprises.reputation.loa.LoaRenderParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
HttpResponse response = client.enterprises().reputation().loa().render("4a6192a4-573d-446d-b3ce-aff9117272a6");
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
response = telnyx.enterprises.reputation.loa.render("4a6192a4-573d-446d-b3ce-aff9117272a6")
puts(response)<?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 {
$response = $client->enterprises->reputation->loa->render(
'4a6192a4-573d-446d-b3ce-aff9117272a6',
agent: [
'administrativeArea' => 'administrative_area',
'city' => 'city',
'contactEmail' => '[email protected]',
'contactName' => 'contact_name',
'contactPhone' => '+13125550000',
'contactTitle' => 'contact_title',
'country' => 'US',
'legalName' => 'legal_name',
'postalCode' => 'postal_code',
'streetAddress' => 'street_address',
'dba' => 'dba',
'extendedAddress' => 'extended_address',
],
signature: ['imageBase64' => 'image_base64', 'signerName' => 'signer_name'],
);
var_dump($response);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx enterprises:reputation:loa render \
--api-key 'My API Key' \
--enterprise-id 4a6192a4-573d-446d-b3ce-aff9117272a6curl --request POST \
--url https://api.telnyx.com/v2/enterprises/{enterprise_id}/reputation/loa \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'"<string>"