7.2. UIN Management

This is version 1.2.0 of this interface.

Get the OpenAPI file: uin.yaml

UIN Management

generateUIN

7.2.1. Services

7.2.1.1. default

POST /v1/uin

Request the generation of a new UIN. The request body should contain a list of attributes and their value, formatted as a json dictionary.

Scope required: uin.generate

Query Parameters

• transactionId (string) – The id of the transaction. (Required)

Form Parameters

• body – A set of attributes for the person.

Status Codes

• 200 OK – UIN is generated.

• 400 Bad Request – Unexpected error.

• 401 Unauthorized – Client must be authenticated.

• 403 Forbidden – Service forbidden.

• 500 Internal Server Error – Unexpected error.

Example request:

POST /v1/uin?transactionId=string HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "firstName": "John",
    "lastName": "Doo",
    "dateOfBirth": "1984-11-19"
}

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

"1235567890"

Example response:

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}

Example response:

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "code": 1,
    "message": "string"
}