Appearance
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 |
Sandbox testing
See the Sandbox Context page for phone formats, network prefixes, and test numbers.
Request
Request Type : GET
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