Retrieve a number order
GET/origination/number_orders/:order_request_id
Retrieves the details of an existing number order.
Request
Path Parameters
Order request id
Responses
200: Number Order Response
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
uuid.
Count of requested numbers associated to the order.
Timestamp of resource creation.
Timestamp of due date for requirements if needed to be met.
True if all requirements are met for every phone number, false otherwise.
requested_numbers
object[]
phone number.
Status of the requested number: pending, success, failure.
True if successfully purchased, false otherwise.
The value of the customer_name
requirement if provided at the time of purchase.
The value of the customer_phone
requirement if provided at the time of purchase.
The value of the tax_id
requirement if provided at the time of purchase.
True if all requirements are met for a phone number, false otherwise.
provided_documents
object
List of Number Document ids.
List of Number Document ids.
List of Number Document ids.
requested_inexplicit_numbers
object[]
List of phone numbers that have been allocated so far.
The value of the customer_name
requirement if provided at the time of purchase.
The value of the customer_phone
requirement if provided at the time of purchase.
The value of the tax_id
requirement if provided at the time of purchase.
True if all requirements are met, false otherwise.
provided_documents
object
List of Number Document ids.
List of Number Document ids.
List of Number Document ids.
ID of connection associated to phone numbers in the order.
{
"order_request_id": "7e610e23-d1f2-4f90-b5b7-3ddd7b32ad7c",
"numbers_count": 1,
"date_created": "2018-02-08T18:49:22.998023Z",
"date_due": "2018-02-08T18:49:22.998023Z",
"requirements_met": true,
"requested_numbers": [
{
"number": "string",
"status": "success",
"allocated": true,
"customer_name": "string",
"customer_phone": "string",
"tax_id": "string",
"requirements_met": true,
"requirements": [
{}
],
"provided_documents": {
"address_proof_file_ids": [
"string"
],
"identification_file_ids": [
"string"
],
"reg_form_file_ids": [
"string"
]
}
}
],
"requested_inexplicit_numbers": [
{
"region_name": "string",
"region_type": "string",
"national_destination_code": "string",
"country_iso": "string",
"quantity": 0,
"allocated_telephone_numbers": [
"string"
],
"customer_name": "string",
"customer_phone": "string",
"tax_id": "string",
"requirements_met": true,
"requirements": [
{}
],
"provided_documents": {
"address_proof_file_ids": [
"string"
],
"identification_file_ids": [
"string"
],
"reg_form_file_ids": [
"string"
]
}
}
],
"connection_id": "string"
}
401: Unauthorized
404: Resource not found