import requests
response = requests.get(
"https://api.tracklysms.com/api/v2/number-requests/665f0a1b2c3d4e5f60718293/international-requirements",
headers={"X-Api-Key": "trk_your_api_key_here"},
)
{
"internationalAcquisition": {
"status": "UPDATE_REQUESTED",
"requirements": [
{
"key": "companyName",
"label": "Company legal name",
"type": "text",
"required": true
},
{
"key": "proofOfBusinessRegistration",
"label": "Proof of business registration",
"type": "document",
"required": true,
"documentTypes": ["BUSINESS_REGISTRATION"]
}
],
"formData": {
"companyName": "Acme Incorporated"
},
"documents": [
{
"requirementKey": "proofOfBusinessRegistration",
"filename": "registration.pdf",
"contentType": "application/pdf",
"size": 48192,
"uploadedAt": "2026-08-03T22:10:00"
}
],
"feedback": {
"proofOfBusinessRegistration": "Upload a current document."
}
}
}
Number Requests (v2)
Get International Requirements
Read dynamic requirements, saved answers, documents, feedback, and provider status.
GET
/
v2
/
number-requests
/
{request_id}
/
international-requirements
import requests
response = requests.get(
"https://api.tracklysms.com/api/v2/number-requests/665f0a1b2c3d4e5f60718293/international-requirements",
headers={"X-Api-Key": "trk_your_api_key_here"},
)
{
"internationalAcquisition": {
"status": "UPDATE_REQUESTED",
"requirements": [
{
"key": "companyName",
"label": "Company legal name",
"type": "text",
"required": true
},
{
"key": "proofOfBusinessRegistration",
"label": "Proof of business registration",
"type": "document",
"required": true,
"documentTypes": ["BUSINESS_REGISTRATION"]
}
],
"formData": {
"companyName": "Acme Incorporated"
},
"documents": [
{
"requirementKey": "proofOfBusinessRegistration",
"filename": "registration.pdf",
"contentType": "application/pdf",
"size": 48192,
"uploadedAt": "2026-08-03T22:10:00"
}
],
"feedback": {
"proofOfBusinessRegistration": "Upload a current document."
}
}
}
Returns the current provider requirement schema and request-owned acquisition state for one account-owned number request.
Document metadata contains
Path parameters
string
required
Number request id.
Response
object
Contains:
status: current Resource Request status;requirements: allowlisted provider requirement schema;formData: saved request-owned form values;documents: safe request-owned document metadata;feedback: provider feedback keyed by requirement.
requirementKey, filename, contentType, size, and uploadedAt. The response never returns private attachment paths, provider request ids, provider document ids, or Business Profile document ids.
Example
import requests
response = requests.get(
"https://api.tracklysms.com/api/v2/number-requests/665f0a1b2c3d4e5f60718293/international-requirements",
headers={"X-Api-Key": "trk_your_api_key_here"},
)
{
"internationalAcquisition": {
"status": "UPDATE_REQUESTED",
"requirements": [
{
"key": "companyName",
"label": "Company legal name",
"type": "text",
"required": true
},
{
"key": "proofOfBusinessRegistration",
"label": "Proof of business registration",
"type": "document",
"required": true,
"documentTypes": ["BUSINESS_REGISTRATION"]
}
],
"formData": {
"companyName": "Acme Incorporated"
},
"documents": [
{
"requirementKey": "proofOfBusinessRegistration",
"filename": "registration.pdf",
"contentType": "application/pdf",
"size": 48192,
"uploadedAt": "2026-08-03T22:10:00"
}
],
"feedback": {
"proofOfBusinessRegistration": "Upload a current document."
}
}
}
Error codes
| HTTP | Code | Meaning |
|---|---|---|
| 401 | invalid_credentials | API key is missing or invalid. |
| 404 | not_found | Request does not belong to the API-key account. |
| 409 | acquisition_not_available | Request target or number type has no dynamic acquisition path. |
| 503 | acquisition_requirements_unavailable | Provider requirements are temporarily unavailable. Retry later. |
Next steps
Update Requirements
Save corrected values and documents
Submit Correction
Update the same provider Resource Request