StreamlineAppearance
Get All Phone Number Verification Requests.
Endpoint for getting all Phone Number Verification requests by search filter.
Endpoints
| Environment | URL |
|---|---|
| Sandbox | https://api-test.streamline.laboremus.ug/phone-verify/api/Verification[?RequesterId][&VerificationStatuses][&Statuses][&PhoneNumber][&From][&To][&ReferenceId][&Query][&Skip][&Limit]&v=1.0 |
| Production | https://api.streamline.laboremus.ug/phoneid/api/Verification |
Request
Request Type : GET
Authorization
There are two ways to be authorized when making this request.
js
const token = 'eyJhbGciOiJIUzI1NiIsInR5.eyJzd...ssw5c'
axios.get(API_ENDPOINT,
headers: {
Authorization: `Bearer ${token}`
}
)const token = 'eyJhbGciOiJIUzI1NiIsInR5.eyJzd...ssw5c'
axios.get(API_ENDPOINT,
headers: {
Authorization: `Bearer ${token}`
}
)js
import axios from 'axios'
import oauth from 'axios-oauth-client'
const getClientCredentials = oauth.clientCredentials(
axios.create(),
'https://oauth.com/2.0/token',
'CLIENT_ID',
'CLIENT_SECRET'
)
const auth = await getClientCredentials('OPTIONAL_SCOPES')
// => { "access_token": "...", "expires_in": 900, ... }
axios.get(API_ENDPOINT,
headers: {
Authorization: `Bearer ${auth.access_token}`
}
)import axios from 'axios'
import oauth from 'axios-oauth-client'
const getClientCredentials = oauth.clientCredentials(
axios.create(),
'https://oauth.com/2.0/token',
'CLIENT_ID',
'CLIENT_SECRET'
)
const auth = await getClientCredentials('OPTIONAL_SCOPES')
// => { "access_token": "...", "expires_in": 900, ... }
axios.get(API_ENDPOINT,
headers: {
Authorization: `Bearer ${auth.access_token}`
}
)INFO
Always add your Subscription key to the request.
Subscription Key
Include your subscription key in every request using one of these methods:
| Method | Header/Parameter |
|---|---|
| Header (recommended) | Ocp-Apim-Subscription-Key: <your_key> |
| Query parameter | ?subscription-key=<your_key> |
bash
curl --request GET \
--url 'https://api.example.com/endpoint' \
--header 'Authorization: Bearer <access_token>' \
--header 'Ocp-Apim-Subscription-Key: <your_subscription_key>'curl --request GET \
--url 'https://api.example.com/endpoint' \
--header 'Authorization: Bearer <access_token>' \
--header 'Ocp-Apim-Subscription-Key: <your_subscription_key>'js
const response = await fetch(API_ENDPOINT, {
headers: {
'Authorization': `Bearer ${accessToken}`,
'Ocp-Apim-Subscription-Key': '<your_subscription_key>'
}
})const response = await fetch(API_ENDPOINT, {
headers: {
'Authorization': `Bearer ${accessToken}`,
'Ocp-Apim-Subscription-Key': '<your_subscription_key>'
}
})python
import requests
response = requests.get(
API_ENDPOINT,
headers={
'Authorization': f'Bearer {access_token}',
'Ocp-Apim-Subscription-Key': '<your_subscription_key>'
}
)import requests
response = requests.get(
API_ENDPOINT,
headers={
'Authorization': f'Bearer {access_token}',
'Ocp-Apim-Subscription-Key': '<your_subscription_key>'
}
)csharp
var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Bearer", accessToken);
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "<your_subscription_key>");
var response = await client.GetAsync(API_ENDPOINT);var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Bearer", accessToken);
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "<your_subscription_key>");
var response = await client.GetAsync(API_ENDPOINT);java
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create(API_ENDPOINT))
.header("Authorization", "Bearer " + accessToken)
.header("Ocp-Apim-Subscription-Key", "<your_subscription_key>")
.GET()
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create(API_ENDPOINT))
.header("Authorization", "Bearer " + accessToken)
.header("Ocp-Apim-Subscription-Key", "<your_subscription_key>")
.GET()
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());Path Parameters Values
| Name | Type | Required | Description |
|---|---|---|---|
| id | string(uuid) | yes | The Unique ID of a URSB-AnnualReturns request |
Query Parameters Values
| Name | Type | Required | Description |
|---|---|---|---|
| RequesterId | string or null | no | The unique Id for the request initiator |
| VerificationStatus | Array of string (Enum: Unknown, Valid, Invalid) | no | The verification stage status |
| Statuses | Array of string (Enum: Pending, Completed, Error) | no | The stage at which the request is at |
| PhoneNumber | string or null | no | Phone number sent in request payload. |
| From | string (date-time) | no | Start date in query. |
| To | string (date-time) | no | End date in query. |
| ReferenceId | string or null | no | Reference Id sent in the verification request. |
| Query | string or null | no | Search input. |
| Skip | integer (int32) | no | Page number |
| Limit | integer (int32) | no | Number of responses per page. |
Response
Response Values
Content type
application/json
| Name | Type | Description |
|---|---|---|
| statusCode | integer (int32) |
Example Response Body
json
{
"statusCode": 0,
}{
"statusCode": 0,
}Error Response
400 Bad Request
application/json
| Name | Type | Description |
|---|---|---|
| statusCode | integer(int32) | The status of the error response |
Example Error Response
json
{
"statusCode": 0
}{
"statusCode": 0
}401 Unauthorized
application/json
| Name | Type | Description |
|---|---|---|
| statusCode | integer(int32) | The status of the error response |
Example Error Response
json
{
"statusCode": 0
}{
"statusCode": 0
}500 Server Error
No response