Number Order Documents API

Number order documents

List number order documents

Gets a paginated list of number order documents.

SecuritybearerAuth
Request
query Parameters
filter[requirement_id]
string

Filter number order documents by requirement_id.

filter[created_at][gt]
string

Filter number order documents after this datetime.

filter[created_at][lt]
string

Filter number order documents from before this datetime.

page[number]
integer >= 1
Default: 1

The page number to load

page[size]
integer [ 1 .. 250 ]
Default: 20

The size of the page

Responses
200

Successful response with a list of number order documents.

Response Schema: application/json
Array of objects (NumberOrderDocument)
object (PaginationMeta)
default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
get/number_order_documents
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "created_at": "2018-01-01T00:00:00.000000Z",
      • "customer_reference": "MY REF 001",
      • "file_id": "1e3c5822-0362-4702-8e46-5a129f0d3976",
      • "id": "387d1e31-a218-4375-8151-103f2d5e2d2c",
      • "record_type": "number_order_document",
      • "requirement_type": "address_proof",
      • "requirements_id": "36aaf27d-986b-493c-bd1b-de16af2e4292"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}
Create a number order document
Upload a phone number order document.


SecuritybearerAuth 
Request 
Request Body schema: application/json
required
customer_reference
string
A customer reference string for customer look ups.


 
file_id
string
The id of the file to associate as a number order document.


 
requirements_id
string
Unique id for a requirement.


 
Responses 
200
Successful response with details about a number order document.


Response Schema: application/json
object (NumberOrderDocument) 
 
created_at
string <datetime> 
An ISO 8901 datetime string denoting when the number order document was uploaded.


 
customer_reference
string
A customer reference string for customer look ups.


 
file_id
string
The id of the file to associate as a number order document.


 
id
string <uuid> 
 
record_type
string
 
requirement_type
string
 Enum: "address_proof" "identification" "reg_form"  
requirements_id
string
Unique id for a requirement.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
post/number_order_documents
Request samples 
application/json
{
  • "created_at": "2018-01-01T00:00:00.000000Z",
  • "customer_reference": "MY REF 001",
  • "file_id": "1e3c5822-0362-4702-8e46-5a129f0d3976",
  • "id": "387d1e31-a218-4375-8151-103f2d5e2d2c",
  • "record_type": "number_order_document",
  • "requirement_type": "address_proof",
  • "requirements_id": "36aaf27d-986b-493c-bd1b-de16af2e4292"
}
Response samples 
application/json
{
  • "data": {
    • "created_at": "2018-01-01T00:00:00.000000Z",
    • "customer_reference": "MY REF 001",
    • "file_id": "1e3c5822-0362-4702-8e46-5a129f0d3976",
    • "id": "387d1e31-a218-4375-8151-103f2d5e2d2c",
    • "record_type": "number_order_document",
    • "requirement_type": "address_proof",
    • "requirements_id": "36aaf27d-986b-493c-bd1b-de16af2e4292"
    }
}
Retrieve a number order document
Gets a single number order document.


SecuritybearerAuth 
Request 
path Parameters
number_order_document_id
required
string
The number order document ID.


 
Responses 
200
Successful response with details about a number order document.


Response Schema: application/json
object (NumberOrderDocument) 
 
created_at
string <datetime> 
An ISO 8901 datetime string denoting when the number order document was uploaded.


 
customer_reference
string
A customer reference string for customer look ups.


 
file_id
string
The id of the file to associate as a number order document.


 
id
string <uuid> 
 
record_type
string
 
requirement_type
string
 Enum: "address_proof" "identification" "reg_form"  
requirements_id
string
Unique id for a requirement.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
get/number_order_documents/{number_order_document_id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "created_at": "2018-01-01T00:00:00.000000Z",
    • "customer_reference": "MY REF 001",
    • "file_id": "1e3c5822-0362-4702-8e46-5a129f0d3976",
    • "id": "387d1e31-a218-4375-8151-103f2d5e2d2c",
    • "record_type": "number_order_document",
    • "requirement_type": "address_proof",
    • "requirements_id": "36aaf27d-986b-493c-bd1b-de16af2e4292"
    }
}
Update a number order document
Updates a number order document.


SecuritybearerAuth 
Request 
path Parameters
number_order_document_id
required
string
The number order document ID.


 
Request Body schema: application/json
required
customer_reference
string
A customer reference string for customer look ups.


 
file_id
string
The id of the file to associate as a number order document.


 
requirements_id
string
Unique id for a requirement.


 
Responses 
200
Successful response with details about a number order document.


Response Schema: application/json
object (NumberOrderDocument) 
 
created_at
string <datetime> 
An ISO 8901 datetime string denoting when the number order document was uploaded.


 
customer_reference
string
A customer reference string for customer look ups.


 
file_id
string
The id of the file to associate as a number order document.


 
id
string <uuid> 
 
record_type
string
 
requirement_type
string
 Enum: "address_proof" "identification" "reg_form"  
requirements_id
string
Unique id for a requirement.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
patch/number_order_documents/{number_order_document_id}
Request samples 
application/json
{
  • "created_at": "2018-01-01T00:00:00.000000Z",
  • "customer_reference": "MY REF 001",
  • "file_id": "1e3c5822-0362-4702-8e46-5a129f0d3976",
  • "id": "387d1e31-a218-4375-8151-103f2d5e2d2c",
  • "record_type": "number_order_document",
  • "requirement_type": "address_proof",
  • "requirements_id": "36aaf27d-986b-493c-bd1b-de16af2e4292"
}
Response samples 
application/json
{
  • "data": {
    • "created_at": "2018-01-01T00:00:00.000000Z",
    • "customer_reference": "MY REF 001",
    • "file_id": "1e3c5822-0362-4702-8e46-5a129f0d3976",
    • "id": "387d1e31-a218-4375-8151-103f2d5e2d2c",
    • "record_type": "number_order_document",
    • "requirement_type": "address_proof",
    • "requirements_id": "36aaf27d-986b-493c-bd1b-de16af2e4292"
    }
}