Request for person mobile number auth

POST /api/v1/PersonNumber/RequestAuthorization

Description

This endpoint is used to request authorization for a person's mobile number.

Tags: PersonNumber

URL:
/api/v{version}/PersonNumber/RequestAuthorization

ApiKey:
No API key required

Content-Type:
application/json, text/json, application/*+json

Query Parameters:
version: string, required
Accept-Language: header, optional, change the default response message language from English(en) to French(fr) or English(en)

Request Body:
RequestAuthorisationCommand

Response:
Success, returns a StringResponse object indicating the authorization request was successful.
400: Bad Request
404: Not Found

Example:

/api/v`{{version}}`/PersonNumber/RequestAuthorization

Headers

Content-Type	Value
Accept-Language

Headers

Content-Type	Value
Content-Type	application/json

Headers

Content-Type	Value
Accept	text/plain

Body (raw)

{
  "personId": `<uuid>`
}

Response: 200

{
  "succeeded": `<boolean>`,
  "message":`<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": `<string>`
}

Response: 400

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
   `<string>`
  ],
  "data": `<string>`
}

Response: 404

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": `<string>`
}