List carrier documents

GET

api

{version}

carriers

{carrierId}

documents

List carrier documents

curl --request GET \
  --url https://integrations.alvys.com/api/p/v{version}/carriers/{carrierId}/documents \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://integrations.alvys.com/api/p/v{version}/carriers/{carrierId}/documents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://integrations.alvys.com/api/p/v{version}/carriers/{carrierId}/documents"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/carriers/{carrierId}/documents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://integrations.alvys.com/api/p/v{version}/carriers/{carrierId}/documents"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

[
  {
    "id": "<string>",
    "AttachmentPath": "<string>",
    "AttachmentType": "<string>",
    "ParentId": "<string>",
    "ParentType": "<string>",
    "AttachmentSize": 123,
    "UploadedAt": "2023-11-07T05:31:56Z",
    "UploadedBy": "<string>",
    "DownloadUrl": "<string>",
    "ExpiresAt": "2023-11-07T05:31:56Z"
  }
]

{
  "Errors": {},
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

Retrieve all uploaded documents associated with a specific Carrier by its unique carrierId.

Request Parameters

Parameter	Type	Required	Description
version	String	Yes	API version to use.
carrierId	String	Yes	Unique identifier of the carrier.

Example cURL Request

curl --location 'https://integrations.alvys.com/api/p/v{version}/carriers/{carrierId}/documents' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace {version} with the API version, {carrierId} with the actual carrier ID, and YOUR_ACCESS_TOKEN with a valid token.

Response Body

Array of document objects:

Name	Type	Description
id	string	Unique identifier of the document.
AttachmentPath	string	File name and extension assigned on upload (with timestamp suffix).
AttachmentType	string	Type of document (e.g., Carrier Agreement, Carrier Authority).
AttachmentSize	integer	Size of the file in bytes.
UploadedAt	string	UTC timestamp when the file was uploaded (ISO 8601).
ParentId	string	Identifier of the parent entity (`carrierId`).
ParentType	string	Entity type the document is attached to (`Carrier`).
UploadedBy	string	User ID if uploaded via UI, or Client ID if uploaded via API.
DownloadUrl	string	Time-limited link (10 minutes) to download the document.
ExpiresAt	string	Expiration timestamp of the `DownloadUrl`.

Example Response (200 OK)

[
  {
    "id": "a314c7cd-0000a-1111-0000-06406a9e000a",
    "AttachmentPath": "CarrierAuthority-1759237626.pdf",
    "AttachmentType": "Carrier Authority",
    "AttachmentSize": 170225,
    "UploadedAt": "2025-09-30T13:07:07+00:00",
    "ParentId": "1111111-956d-4511-a1ed-4b9072sder55f",
    "ParentType": "Carrier",
    "UploadedBy": "10000000eecc0000e90d7173f4ece0e00",
    "DownloadUrl": "https://alvysqastorage.blob.core.windows.net/tl743/CarrierAuthority-1759237626.pdf?...",
    "ExpiresAt": "2025-09-30T13:17:15.9506343+00:00"
  }
]

Rate Limits

All endpoints are subject to rate limits to protect the API from traffic spikes. For detailed information, see the Rate Limits section.

Try It Out

This page is interactive, allowing you to try a request by specifying the API version and carrierId in the URL path. As you fill out the parameters, the cURL command on the right side of the page will be automatically updated. Alternatively, you can directly edit the cURL command. ⚠️ Don’t forget: make sure to authorize yourself before trying a request.

Authorizations

Authorization

string

header

required

OAuth 2.0 client-credentials access token. Obtain one from https://auth.alvys.com/oauth/token (grant_type=client_credentials, audience=https://api.alvys.com/public/), then paste it here. The playground sends it as Authorization: Bearer <token>.

Path Parameters

carrierId

string

required

version

string

default:1.0

required

API version (e.g., 1.0)

Example:

"1.0"

Response

string

required

AttachmentPath

string

required

AttachmentType

string

required

ParentId

string

required

ParentType

string

required

AttachmentSize

integer<int64> | null

UploadedAt

string<date-time> | null

UploadedBy

string | null

DownloadUrl

string | null

ExpiresAt

string<date-time> | null

⌘I

List carrier documents

curl --request GET \
  --url https://integrations.alvys.com/api/p/v{version}/carriers/{carrierId}/documents \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://integrations.alvys.com/api/p/v{version}/carriers/{carrierId}/documents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://integrations.alvys.com/api/p/v{version}/carriers/{carrierId}/documents"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/carriers/{carrierId}/documents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://integrations.alvys.com/api/p/v{version}/carriers/{carrierId}/documents"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

[
  {
    "id": "<string>",
    "AttachmentPath": "<string>",
    "AttachmentType": "<string>",
    "ParentId": "<string>",
    "ParentType": "<string>",
    "AttachmentSize": 123,
    "UploadedAt": "2023-11-07T05:31:56Z",
    "UploadedBy": "<string>",
    "DownloadUrl": "<string>",
    "ExpiresAt": "2023-11-07T05:31:56Z"
  }
]

{
  "Errors": {},
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

​Request Parameters

​Example cURL Request

​Response Body

​Example Response (200 OK)

​Rate Limits

​Try It Out

Authorizations

Path Parameters

Response

Request Parameters

Example cURL Request

Response Body

Example Response (200 OK)

Rate Limits

Try It Out