Appearance
Create Phone Number verification Request.
Accepts requests for creating a Phone Number Verification Request.
Endpoints
| Environment | URL |
|---|---|
| Sandbox | https://api-test.streamline.laboremus.ug/phone-verify/api/Verification?v=1.0 |
| Production | https://api.streamline.laboremus.ug/phoneid/api/Verification?v=1.0 |
Request
Request Type : POST
Authorization
All requests must be authenticated using OAuth 2.0 Client Credentials. Follow the steps in the Authentication section to obtain an access token.
Request Values
| Name | Type | Required | Description |
|---|---|---|---|
| referenceId | string or null | no | A Guid / uuid / A set of unique Alphanumerical characters assigned to this verification request. |
| phoneNumber | string | yes | Phone number starting with prefix (256) |
Example Request Body
json
{
"referenceId": "string",
"phoneNumber": "string"
}{
"referenceId": "string",
"phoneNumber": "string"
}Response
Response Values
Content type
application/json
| Name | Type | Description |
|---|---|---|
| id | string (uuid) | The unique id for the request |
| createdAt | string (date-time) | Date the request was created. |
| requesterId | string or null | The unique Id for the request initiator |
| status | string (Enum: Pending, Completed, Error) | The status of the execution |
| verificationStatus | string (Enum: Unknown, Valid, Invalid) | The verification status reply |
| phoneNumber | string or null | Phone number sent in request payload. |
| sentAt | string or null (date-time) | Date the request was sent. |
| referenceId | string or null | Reference Id sent in the verification request. |
| responsePayload | string or null | String containing a verification response. |
| processedAt | string or null (date-time) | Date at which the verification request was processed. |
| errorCode | string or null | The code of the error returned. |
| errorMessage | string or null | The Description of the error returned. |
Example Response Body
json
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createdAt": "2019-08-24T14:15:22Z",
"requesterId": "string",
"status": "Pending",
"verificationStatus": "Unknown",
"phoneNumber": "string",
"sentAt": "2019-08-24T14:15:22Z",
"referenceId": "string",
"responsePayload": "string",
"processedAt": "2019-08-24T14:15:22Z",
"errorCode": "string",
"errorMessage": "string"
}{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createdAt": "2019-08-24T14:15:22Z",
"requesterId": "string",
"status": "Pending",
"verificationStatus": "Unknown",
"phoneNumber": "string",
"sentAt": "2019-08-24T14:15:22Z",
"referenceId": "string",
"responsePayload": "string",
"processedAt": "2019-08-24T14:15:22Z",
"errorCode": "string",
"errorMessage": "string"
}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