API reference

Compliance

Identity verification and US calling compliance.

6 operationsBase URL https://packetexchange.io/api/v1Postman collection

BrowseCompliance

Start identity verification

POST/api/v1/kyc/start

Access: API key. Scoped keys need billing:write.
Rate limit: 10 requests per minute

Begins a verification with the identity provider and returns the hosted page to open. Each call starts a new attempt.

Request body (application/json)

Field	Type	Description
`accountType`required	string	-One of `individual`, `business`

Response 200

Field	Type	Description
`data`required	object	-
`verificationUrl`requireddata.verificationUrl	string (uri)	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/kyc/start" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accountType": "individual"
}'

Run it here with a test key.

Get your identity verification status

GET/api/v1/kyc/status

Access: API key. Full-access keys only; not reachable by scoped keys.
Rate limit: 100 requests per second (the default)

depositGate says whether verification is currently required before adding or withdrawing funds; configured whether verification is available at all.

Response 200

Field	Type	Description
`data`required	object	-
`kycStatus`requireddata.kycStatus	string	-One of `not_started`, `pending`, `verified`, `rejected`
`accountType`requireddata.accountType	string \| null	-One of `individual`, `business`
`kycExempt`requireddata.kycExempt	boolean	-
`depositGate`requireddata.depositGate	boolean	-
`configured`requireddata.configured	boolean	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Get your US calling compliance profile

GET/api/v1/us-compliance/profile

Access: API key. Full-access keys only; not reachable by scoped keys.
Rate limit: 100 requests per second (the default)

Your STIR/SHAKEN and FCC registrations, reused for every US voice purchase. data is null until you submit one.

Response 200

Field	Type	Description
`data`required	object \| null	-
`userId`requireddata.userId	string (uuid)	-
`legalBusinessName`requireddata.legalBusinessName	string	-
`contactName`requireddata.contactName	string	-
`contactEmail`requireddata.contactEmail	string	-
`contactPhone`requireddata.contactPhone	string \| null	-
`frn`requireddata.frn	string	FCC Registration Number
`filer499Id`requireddata.filer499Id	string	FCC Form 499 Filer ID
`ocn`requireddata.ocn	string	Operating Company Number
`rmdRegistered`requireddata.rmdRegistered	boolean	Listed in the FCC Robocall Mitigation Database
`rmdReference`requireddata.rmdReference	string \| null	-
`signsOwnTraffic`requireddata.signsOwnTraffic	boolean	Signs its own STIR/SHAKEN attestations
`stirShakenCert`requireddata.stirShakenCert	string \| null	-
`attestationLevel`requireddata.attestationLevel	string \| null	-One of `A`, `B`, `C`
`termsAcceptedAt`requireddata.termsAcceptedAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`submittedAt`requireddata.submittedAt	string (date-time)	ISO-8601 timestamp (UTC)
`updatedAt`requireddata.updatedAt	string (date-time)	ISO-8601 timestamp (UTC)

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Submit or update your US calling compliance profile

PUT/api/v1/us-compliance/profile

Access: API key. Full-access keys only; not reachable by scoped keys.
Rate limit: 100 requests per second (the default)

Required before a US voice route purchase can be reviewed. Accepting the terms stamps termsAcceptedAt.

Request body (application/json)

Field	Type	Description
`legalBusinessName`required	string	-max 255 chars
`contactName`required	string	-max 255 chars
`contactEmail`required	string (email)	-max 255 chars
`contactPhone`	string \| null	-max 40 chars
`frn`required	string	-max 40 chars
`filer499Id`required	string	-max 40 chars
`ocn`required	string	-max 20 chars
`rmdRegistered`required	boolean	-
`rmdReference`	string \| null	-max 2000 chars
`signsOwnTraffic`required	boolean	-
`stirShakenCert`	string \| null	-max 4000 chars
`attestationLevel`	string \| null	-One of `A`, `B`, `C`
`termsAccepted`required	boolean	-

Response 200

Field	Type	Description
`data`required	object	Same fields as UsComplianceProfile, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X PUT "https://packetexchange.io/api/v1/us-compliance/profile" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "legalBusinessName": "<legalBusinessName>",
  "contactName": "<contactName>",
  "contactEmail": "you@example.com",
  "frn": "<frn>",
  "filer499Id": "<filer499Id>",
  "ocn": "<ocn>",
  "rmdRegistered": true,
  "signsOwnTraffic": true,
  "termsAccepted": true
}'

Run it here with a test key.

Check whether a route needs a US compliance profile

GET/api/v1/us-compliance/route/{routeId}/requirement

Access: API key. Full-access keys only; not reachable by scoped keys.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`routeId`required	path	string	-

Response 200

Field	Type	Description
`data`required	object	-
`required`requireddata.required	boolean	-
`hasProfile`requireddata.hasProfile	boolean	-
`profileComplete`requireddata.profileComplete	boolean	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Get your US compliance review status

GET/api/v1/us-compliance/status

Access: API key. Full-access keys only; not reachable by scoped keys.
Rate limit: 100 requests per second (the default)

actionNeeded is true when a US purchase is waiting on review and your profile is not complete enough for it to proceed.

Response 200

Field	Type	Description
`data`required	object	-
`hasProfile`requireddata.hasProfile	boolean	-
`profileComplete`requireddata.profileComplete	boolean	-
`pendingReviewCount`requireddata.pendingReviewCount	integer	-
`actionNeeded`requireddata.actionNeeded	boolean	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.