Skip to main content

Reauthorize person mobile number

POST /api/v1/PersonNumber/Reauthorise

Description

This endpoint is used to reauthorize a person's mobile number.

Tags: PersonNumber

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

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:
ReauthorisationPhoneNumberCommand

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

/api/v1/PersonNumber/Reauthorise

Headers

Content-TypeValue
Accept-Language

Headers

Content-TypeValue
Content-Typeapplication/json

Headers

Content-TypeValue
Accepttext/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>"
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request POST \ 
--url /api/v1/PersonNumber/Reauthorise \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


Click Try It! to start a request and see the response here!