Setting a PIN | NAGRAVISION Documentation Portal

Request

If a PIN has not been set for the account (or if the PIN setting procedure was started on a different device but not completed), the client application should prompt the user to set the PIN. The client should do this for each defined PIN type.

To determine the status of the PIN, see Getting the status of all PINs for the account.

To set a PIN, send a POST request to:

https://<host>:<port>/adm/v1/user/accounts/actions/pin

Headers

Content-Type: application/json
Authorisation
nv-tenant-id

Mandatory arguments

All the following arguments are in the request body:

accountId – the account ID
type – the PIN type
value – the value to be set for the PIN

Other arguments

None

Example

A POST request with this payload sets the PIN for the account:

{
  "accountId": "abc123",
  "type": "parental",
  "value": "1234"
}

Response

A successful request returns an HTTP 201 status.

A bad request returns an HTTP 400 status.

An unauthorised request returns an HTTP 401 status.

A forbidden request returns an HTTP 403 status.

If the specified account or PIN type does not exist, the request returns an HTTP 404 status.