API - Description - SMS Phone Confirmation - GDPR_VERIF

Support DQE
Support DQE
  • Updated

The GDPR_VERIF endpoint verifies the PIN code entered by the user against the token returned by a prior GDPR_MSG request.

Related SMS Phone Confirmation documentation:

GET request

Endpoint

https://{SERVER_ADDRESS}/GDPR_VERIF/?Phone={PHONE}&Token={SMS_TOKEN}&Pin={CODE_PIN}

Replace the values in braces with your own information:

Parameter Value Description Mandatory/Optional
SERVER_ADDRESS {SERVER_ADDRESS} Address of the DQE server that will process the data. Mandatory
Phone {PHONE} Phone number in international format. Mandatory
Token {SMS_TOKEN} Identifier returned by the GDPR_MSG request (smsToken field). Mandatory
Pin {CODE_PIN} 6-digit verification code received by the user via SMS. Mandatory

POST request

Endpoint

https://{SERVER_ADDRESS}/GDPR_VERIF/

Add the following parameters in the request body using x-www-form-urlencoded.

Parameter Value Description Mandatory/Optional
Phone {PHONE} Phone number in international format. Mandatory
Token {SMS_TOKEN} Identifier returned by the GDPR_MSG request (smsToken field). Mandatory
Pin {CODE_PIN} 6-digit verification code received by the user via SMS. Mandatory

Response

Success response

The JSON response contains the verification result for the PIN code.

Key Description Format
status OK if the PIN is valid, KO otherwise. STRING
phone Phone number in international format. STRING
dateTime Verification date and time. STRING
channels Selected communication channels. JSON OBJECT
errors Error details. JSON OBJECT

Error codes:

Code Description
00 No errors.
01 Missing parameters.
02 PIN must contain 6 digits.
03 PIN expired.
04 PIN invalid for this token or phone number.
05 Invalid token.

Example:

{
  "status": "OK",
  "phone": "33631525429",
  "errors": {
    "00": "00 - No errors"
  },
  "channels": {
    "phone": 0,
    "post": 0,
    "sms": 1,
    "email": 1
  },
  "dateTime": "2019-07-29 11:34:48.998397"
}

Related to

Was this article helpful?

0 out of 0 found this helpful