Skip to content
Registration Authority
/
/
/
OTP FOR RESET/UNLOCK PIN

UANATACA RA API DOCUMENTATION (v1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

https://api.uanataca.com/

Registration Authority

Operations

Registration Authority Officer

Operations

Users

Operations

Scratchcards

Operations

Requests

Operations

CHECK CONTACT DATA

Request

Checks if the given contact data is already in use.

Body*/*
registration_authoritynumber

Registration authority number where the contact data it's going to be consulted.

serial_numberstring

Serial number to check

emailstring

Email address to check

mobile_phone_numberstring

Mobile phone number to check

curl -i -X POST \
  https://api.uanataca.com/api/v1/requests/check_contact_data_limits/ \
  -H 'Content-Type: */*' \
  -d '[object Object]'

Responses

Successful Response

Body
reasonstring

Response reason

resultstring

Response result

registration_authoritynumber

Registration authority checked

Response
{
  "reason": "string",
  "result": "string",
  "registration_authority": 0
}

OTP FOR RESET/UNLOCK PIN

Request

Sends an OTP code via SMS for PIN reset or unlock.

Path
idstringrequired

The unique identifier of the Request

curl -i -X POST \
  'https://api.uanataca.com/api/v1/requests/{id}/generate_otp_for_unlock'

Responses

Successful Response

Bodyapplication/json
statusstring

Successful status message

messagenumber

Successful status description

Response
application/json
{
  "status": "success",
  "message": "OTP sent via SMS"
}

RESET/UNLOCK PIN

Request

Performs the PIN reset or unlock operation

Path
idstringrequired

The unique identifier of the Request

Bodyapplication/json
scratchcardstring

The scratchcard number (username) associated to the request

enrollment_codestring

The scratchcard enrollment code of the request

newpinstring

The new pin

otpstring

The OTP code sent to the user via SMS

curl -i -X POST \
  'https://api.uanataca.com/api/v1/requests/{id}/unlock_pin' \
  -H 'Content-Type: application/json' \
  -d '{
    "scratchcard": "string",
    "enrollment_code": "string",
    "newpin": "string",
    "otp": "string"
  }'

Responses

Successful response

Bodyapplication/json
statusstring

The response status code

messagestring

The response status message

Response
application/json
{
  "status": "success",
  "message": "Pin unlocked successfully"
}

eIDAS VideoID

Operations

External VideoID

Operations