Authentication

This page contains internal Authentication APIs. Before using, the user must first Self Register then authenticate using the Get Token.

To help you get started with your integration, Cloud Payments provides a sample Postman collection that includes a template of all the Authentication API endpoints. It also includes a sample environment file with the URL details.

Click the button below to download the collection and associated the environment file.

Refresh token

A Refresh Token allows the application to ask the auth server to issue a new Access Token without having to re-authenticate the user. This will work as long as the Refresh Token has not been revoked.

Precondition

The Client must be logged into the service. Refer the section for registration/authentication. The logged in user must have the correct permission to access the API.

Rest Basic Environment	Value
Method	POST
Resource URL	POST http://api-dev.fintiv.co:8080/auth/oauth/token
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

Refresh Tokens Request

curl -X POST
  'http://api-dev.fintiv.co:8080/auth/oauth/token'
  -H 'Content-Type: application/x-www-form-urlencoded'
  -H 'api-key: <Insert your App Key here>'
  -H 'tenantName: JANUS'
  -d 'grant_type=refresh_token&refresh_token=<Insert your refresh token here>'

Request Parameters

Parameter Name	Type	Required	Description
grant_type	String	Yes	Value MUST be set to “refresh_token”
refresh_token	String	Yes	Value of your refresh token.

Refresh Tokens Response

{
    "access_token": "Your access token",
    "expires_in": 3599,
    "jti": "b3448d97-39a9-40fb-990f-74badf32e1dd",
    "last_signon_timestamp": 1561594421802,
    "refresh_token": "Your refresh token",
    "scope": "foo read write",
    "tenant_name": "JANUS",
    "token_type": "bearer",
    "user_type": "SUBSCRIBER",
    "uuid": "johndoe"
}

Obtaining tokens

Access tokens are credentials used to access protected resources. An access token is a string representing an authorization issued to the client. You should include the obtained access token in the request to our resource service to authenticate your application. Refresh tokens are credentials used to obtain access tokens. Refresh tokens are issued to the client by the authorization server and are used to obtain a new access token when the current access token becomes invalid or expires. In this request, you can obtain both your access token and refresh token.

Precondition

Client registered service using self register API.

Rest Basic Environment	Value
Method	POST
Resource URL	POST/ http://api-dev.fintiv.co:8080/auth/oauth/token
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

Obtaining Tokens Request

curl -X POST
  'http://api-dev.fintiv.co:8080/auth/oauth/token?='
  -H 'Content-Type: application/x-www-form-urlencoded'
  -H 'api-key: <Insert your App Key here>'
  -H 'tenantName: JANUS'
  -d 'grant_type=password&username=johndoe&password=Password!'

Request Parameters

Parameter Name	Type	Required	Description
grant_type	String	Yes	Value MUST beValue MUST be set to “password”
username	String	Yes	Login Credential.
password	String	Yes	User’s password.

Obtaining Tokens Response

 {
     "access_token": "Your access token",
     "expires_in": 3599,
     "jti": "b3448d97-39a9-40fb-990f-74badf32e1dd",
     "last_signon_timestamp": 1561594421802,
     "refresh_token": "Your refresh token",
     "scope": "foo read write",
     "tenant_name": "JANUS",
     "token_type": "bearer",
     "user_type": "SUBSCRIBER",
     "uuid": "johndoe"
 }

Get My Profile

Retrieve the logged-in user’s personal profile.

Precondition

The client is logged into the service. Refer to the registration/authentication section for additional information.

Rest Basic Environment	Value
Method	GET
Resource URL	http://api-dev.fintiv.co:8080/auth/api/myinfo
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

Get My Profile Request

curl -X GET " http://api-dev.fintiv.co:8080/auth/api/myinfo"
-H "accept: */*"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"

Request Parameters

Parameter Name	Type	Required	Description

None

Get My Profile Response Returns result of the Request

{
 "contextResponse": {
   "tenantName": "JANUS",
   "statusCode": "SUCCESS",
   "statusMessage": null,
   "additionalStatusCode": null,
   "additionalStatusMessage": null
 },
 "responseData": {
   "client": {
     "name": "JANUS",
     "description": "JANUS program",
     "defaultRole": null,
     "createdDate": 1548189217249,
     "lastUpdatedDate": 1548189217249
   },
   "firstName": "a",
   "lastName": "20190404",
   "personType": "SUBSCRIBER",
   "status": "ACTIVE",
   "lastLoginDatetime": 1556154384352,
   "loginAttempt": 1,
   "lastPasswordUpdate": 1556154419870,
   "preferredLanguage": "EN",
   "needChangePassword": false,
   "remainingChangePasswordDate": 0,
   "createdDate": 1554397020490,
   "lastUpdatedDate": 1556154420060,
   "timeZoneFormatted": "GMT",
   "personCredentials": [
     {
       "credentialType": "USERNAME",
       "credential": "a20190404",
       "createdDate": 1554397020723,
       "lastUpdatedDate": 1554397020723
     }
   ],
   "personRoles": [
     {
       "role": {
         "name": "CONSUMER",
         "clientName": "JANUS",
         "description": "Consumer role",
         "clientRoleEntitlements": null
       },
       "createdDate": 1554397020822,
       "lastUpdatedDate": 1554397020822
     }
   ],
   "personContacts": [
     {
       "contactType": "EMAIL",
       "contact": "test@liftcommerce.com",
       "createdDate": 1554397020624,
       "lastUpdatedDate": 1554397020624
     }
   ],
   "enabled": true,
   "username": "a20190404",
   "credentialsNonExpired": true,
   "accountNonLocked": true
 }
}

Retrieve Tenant info - by admin

Retrieve the details of a tenant by the administrative user of the tenant. Admin users can retrieve only information from their tenant.

Precondition

Client logged in the service. Refer the section for registration/authentication. The logged in user must have the permission to access the API.

Rest Basic Environment	Value
Method	GET
:---	:---
Resource URL	http://api-dev.fintiv.co:8080/auth/admin/client/{tenantName}
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json	Comment
api-key	{Your APP Key}
authorization	Bearer {access_token}

URI Parameters

Parameter Name	Data Type	Required	Description
tenantName	String	yes	Unique tenantName.

Retrieve Tenant info by admin Request

curl -X GET " http://api-dev.fintiv.co:8080/auth/admin/client/JANUS"
-H "accept: application/json;charset=UTF-8"
-H "api-key: {insert your APP Key here};"
-H "authorization: Bearer {insert your bearer token here}"

Request Parameters

Parameter Name	Data Type	Required	Description

None.

Retrieve Tenant info by admin Response

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": {
    "name": "JANUS",
    "description": "JANUS program",
    "defaultRole": {
      "id": 3,
      "name": "CONSUMER",
      "clientName": "JANUS",
      "description": "Consumer role",
      "clientRoleEntitlements": [
        {
          "id": 7,
          "entitlement": {
            "id": 2,
            "name": "RESET_PASSWORD",
            "description": "Reset User Password",
            "createdDate": 1548207958507,
            "lastUpdatedDate": 1548207958507
          },
          "createdDate": 1548190231554,
          "lastUpdatedDate": 1548190231554,
          "authority": "RESET_PASSWORD"
        },
        {
          "id": 8,
          "entitlement": {
            "id": 3,
            "name": "RESET_PIN",
            "description": "Reset User Pin",
            "createdDate": 1548207958507,
            "lastUpdatedDate": 1548207958507
          },
          "createdDate": 1548190231632,
          "lastUpdatedDate": 1548190231632,
          "authority": "RESET_PIN"
        }
      ]
    },
    "createdDate": 1548189217249,
    "lastUpdatedDate": 1548189217249
  }
}

Create Tenant User

Register a new user into a tenant.

Precondition

Client logged in the service. Refer the section for registration/authentication. The logged in user must have the permission to access the API.

Rest Basic Environment	Value
Method	POST
Resource URL	http://api-dev.fintiv.co:8080/auth/admin/client/person
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

Create Tenant User Request

curl -X POST " http://api-dev.fintiv.co:8080/auth/admin/client/person"
-H "accept: application/json;charset=UTF-8"
-H "tenantName: JANUS"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"
-H "Content-Type: application/json"
-d ‘{
    "contact": "test@test.com",
    "contactType": "EMAIL",
    "firstName": "John",
    "lastName": "Doe",
    "password": "Test1234!",
    "personType": "SUBSCRIBER",
    "pin": "1234",
    "preferredLanguage": "EN",
    "resetRequired": true,
    "roleNames": ["CONSUMER"],
    "timeZoneFormatted": "EST",
    "username": "johndoe",
    "uuid": "johndoe12345"
}’

Request Parameters

Parameter	Type	Required	Description
contact	String	Optional	User’s contact information. Possible values are email or mobile phone number.
contactType	String	Optional	Type of contact, Possible values are EMAIL if contact is email and MOBILE if contact is mobile phone number.
firstName	String	Yes	First name of the user.
lastName	String	Yes	Last name of the user.
password	String	Yes	Password to authenticate the service.
personType	String	Yes	Type of the user in the resource servers. Possible values are BOX_OWNER, COMPANY_USER, SUBSCRIBER, and SERVICE_OWNER.
pin	String	Optional	PIN to be used in the resource servers.
preferredLanguage	String	Optional	User’s preferred language code. Format is ISO 639-1 code.
resetRequired	boolean	Optional	Whether make the user immediately active state. If value is True, user state will be set to ‘INACTIVE’ when user is created the first time. Otherwise user state will be immediately ‘ACTIVE’.
roleName	String	Optional	Name of the role to be assigned to the user. To assign a role, role names should be defined via ClientRole APIs.
timeZoneFormatted	String	Optional	Timezone the user locates. Format is abbreviation of time zone name.
username	String	Yes	User’s login credential.
uuid	String	Yes	Unique user identifier.

Successful Response

Returns a person object.

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": {
    "client": {
      "name": "JANUS",
      "description": "JANUS program",
      "defaultRole": null,
      "createdDate": 1548189217249,
      "lastUpdatedDate": 1548189217249
    },
    "firstName": "John",
    "lastName": "Doe",
    "personType": "SUBSCRIBER",
    "status": "INACTIVE",
    "lastLoginDatetime": null,
    "loginAttempt": 0,
    "lastPasswordUpdate": 1557515935929,
    "preferredLanguage": null,
    "needChangePassword": true,
    "remainingChangePasswordDate": 0,
    "createdDate": 1557515936340,
    "lastUpdatedDate": 1557515936340,
    "timeZoneFormatted": "EST",
    "personCredentials": [
      {
        "credentialType": "USERNAME",
        "credential": "johndoe",
        "createdDate": 1557515936544,
        "lastUpdatedDate": 1557515936544
      }
    ],
    "personRoles": [
      {
        "role": {
          "id": 3,
          "name": "CONSUMER",
          "clientName": "JANUS",
          "description": "Consumer role",
          "clientRoleEntitlements": null
        },
        "createdDate": 1557515936644,
        "lastUpdatedDate": 1557515936644
      }
    ],
    "personContacts": [
      {
        "contactType": "EMAIL",
        "contact": "test@test.com",
        "createdDate": 1557515936444,
        "lastUpdatedDate": 1557515936444
      }
    ],
    "enabled": true,
    "username": "johndoe",
    "credentialsNonExpired": true,
    "accountNonLocked": true,
    "id": "johndoe12345"
  }
}

Delete Tenant User - by Admin

Delete existing user registered in the tenant. Only the same tenant user data can be retrieved.

Precondition

Client logged in the service. Refer the section for registration/authentication. The logged in user must have the permission to access the API.

Rest Basic Environment	Value
Method	DELETE
Resource URL	http://api-dev.fintiv.co:8080/auth/admin/client/person/{uuid}
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{APP Key}
authorization	Bearer {access_token}

Delete Tenant's User Request

curl -X DELETE " http://api-dev.fintiv.co:8080/auth/admin/client/person/johndoe12345"
-H "accept: application/json;charset=UTF-8"
-H "tenantName: JANUS"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"

Request Parameters

None.

Delete Tenant's User Response Returns result of a request.

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": null
}

Find Tenant User by UUID

Supply a user’s Username to retrieve the details of the user information by admin.

Precondition

Client logged in the service. Refer the section for registration/authentication. The user must have the permission to delete own account or someone else’s account.

Rest Basic Environment	Value
Method	GET
Resource URL	/ http://api-dev.fintiv.co:8080/auth/admin/client/person/{uuid}
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

Find Tenant User by UUID Request

curl -X GET " http://api-dev.fintiv.co:8080/auth/admin/client/person/johndoe12345"
-H "accept: application/json;charset=UTF-8"
-H "tenantName: JANUS"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"

Request Parameters

|None.

Successful Response Returns person object.

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": {
    "client": {
      "name": "JANUS",
      "description": "JANUS program",
      "defaultRole": null,
      "createdDate": 1548189217249,
      "lastUpdatedDate": 1548189217249
    },
    "firstName": "John",
    "lastName": "Doe",
    "personType": "SUBSCRIBER",
    "status": "INACTIVE",
    "lastLoginDatetime": null,
    "loginAttempt": 0,
    "lastPasswordUpdate": 1557515935929,
    "preferredLanguage": null,
    "needChangePassword": true,
    "remainingChangePasswordDate": 0,
    "createdDate": 1557515936340,
    "lastUpdatedDate": 1557515936340,
    "timeZoneFormatted": "EST",
    "personCredentials": [
      {
        "credentialType": "USERNAME",
        "credential": "johndoe",
        "createdDate": 1557515936544,
        "lastUpdatedDate": 1557515936544
      }
    ],
    "personRoles": [
      {
        "role": {
          "id": 3,
          "name": "CONSUMER",
          "clientName": "JANUS",
          "description": "Consumer role",
          "clientRoleEntitlements": null
        },
        "createdDate": 1557515936644,
        "lastUpdatedDate": 1557515936644
      }
    ],
    "personContacts": [
      {
        "contactType": "EMAIL",
        "contact": "test@test.com",
        "createdDate": 1557515936444,
        "lastUpdatedDate": 1557515936444
      }
    ],
    "enabled": true,
    "username": "johndoe",
    "credentialsNonExpired": true,
    "accountNonLocked": true,
    "id": "johndoe12345"
  }
}

Retrieve Tenant Users - By Admin

Retrieve all users registered in the tenant.

Precondition

Client logged in the service. Refer the section for registration/authentication. The logged in user must have the permission to access the API.

Rest Basic Environment	Value
Method	GET
Resource URL	http://api-dev.fintiv.co:8080/auth/admin/client/person
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

Retrieve Tenant Users Requests

curl -X GET " http://api-dev.fintiv.co:8080/auth/admin/client/person"
-H "accept: application/json;charset=UTF-8"
-H "tenantName: JANUS"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"

Request Parameters

None.

Response Body Parameters

Attribute	Description
clientId	Unique identifier of the tenant.
clientName	Name of tenant.
firstName	First name of the user.
lastName	Last name of the user.
personType	Type of the user in the resource servers. Possible values are BOX_OWNER, COMPANY_USER, SUBSCRIBER, and SERVICE_OWNER.
status	User’s status. Possible values are: - ACTIVE: User becomes active status after registration. - INACTIVE: Administrator manually registered the user but has not updated status to ‘ACTIVE’. - LOCKED: Account is locked after maximum login retry attempt is all exhausted. Or account is manually locked by the administrator.
createdDate	Created date and time. Format is unix timestamp.
lastUpdatedDate	Last data updated date and time. Format is unix timestamp.
username	User’s login credential.
id	Unique user identifier.

Retrieve Tenant Users Response Returns list of persons registered in the tenant.

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": [
    {
      "clientId": 1,
      "clientName": "JANUS",
      "firstName": "first002",
      "lastName": "last",
      "personType": "SUBSCRIBER",
      "status": "ACTIVE",
      "createdDate": 1548350945048,
      "lastUpdatedDate": 1548350945048,
      "username": "first002@test.com",
      "id": "09234850980534"
    },
    {
      "clientId": 1,
      "clientName": "JANUS",
      "firstName": "first003",
      "lastName": "last",
      "personType": "SUBSCRIBER",
      "status": "ACTIVE",
      "createdDate": 1548435388461,
      "lastUpdatedDate": 1548435388461,
      "username": "first003@test.com",
      "id": "039218540912385"
    },
    {
      "clientId": 1,
      "clientName": "JANUS",
      "firstName": "Mseema211a",
      "lastName": "211a",
      "personType": "SUBSCRIBER",
      "status": "ACTIVE",
      "createdDate": 1557523456254,
      "lastUpdatedDate": 1557523456254,
      "username": "mummada17+211",
      "id": "4b168c2c-a9ca-4531-8fc3-a105878f013e"
    }
  ]
}

Update Tenant User Information

Update existing tenant user’s detail information by admin user. Only existing tenant user data can be updated.

Precondition

Client logged in the service. Refer the section for registration/authentication. The logged in user must have the permission to access the API.

Rest Basic Environment	Value
Method	POST or PUT
Resource URL	http://api-dev.fintiv.co:8080/auth/admin/client/person/{uuid}
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

Update Tenant User Information Request

curl -X POST "http://localhost:8084/admin/client/person/johndoe12345"
-H "accept: application/json;charset=UTF-8"
-H "tenantName: JANUS"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"
-H "Content-Type: application/json"
-d ‘{
    "contact": "johndoe@test.com",
    "contactType": "EMAIL",
    "firstName": "John",
    "lastName": "Doe",
    "password": "Test1234!",
    "personType": "SUBSCRIBER",
    "pin": "1234",
    "preferredLanguage": "EN",
    "resetRequired": true,
    "roleNames": ["CONSUMER"],
    "timeZoneFormatted": "EST",
    "username": "johndoe",
    "uuid": "johndoe12345"
}’

Request Parameters

Parameter	Type	Required	Description
contact	String	Optional	User’s contact information. Possible values are email or mobile phone number.
contactType	String	Optional	Type fo contact. Possible values are EMAIL if contact is email and MOBILE if contact is mobile phone number.
firstName	String	Yes	First name of the user.
lastName	String	Yes	Last name of the user.
password	String	Yes	Password to authenticate the service.
personType	String	Yes	Type of the user in the resource servers. Possible values are BOX_OWNER, COMPANY_USER, SUBSCRIBER, and SERVICE_OWNER.
pin	String	Optional	PIN to be used in the resource servers.
preferredLanguage	String	Optional User’s preferred language code. Format is ISO 639-1 code.
resetRequired	boolean	Optional	Whether make the user immediately active state. If value is True, user state will be set to ‘INACTIVE’ when user is created the first time. Otherwise user state will be immediately ‘ACTIVE’.
roleName	String	Optional	Name of the role to be assigned to the user. To assign a role, role names should be defined via ClientRole APIs.
timeZoneFormatted	String	Optional	Timezone the user locates. Format is abbreviation of time zone name.
username	String	Yes	User’s login credential.
uuid	String	Yes	Unique user identifier.

Update Tenant User Information Response Returns person object.

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": {
    "client": {
      "name": "JANUS",
      "description": "JANUS program",
      "defaultRole": null,
      "createdDate": 1548189217249,
      "lastUpdatedDate": 1548189217249
    },
    "firstName": "John",
    "lastName": "Doe",
    "personType": "SUBSCRIBER",
    "status": "INACTIVE",
    "lastLoginDatetime": null,
    "loginAttempt": 0,
    "lastPasswordUpdate": 1557515935929,
    "preferredLanguage": null,
    "needChangePassword": true,
    "remainingChangePasswordDate": 0,
    "createdDate": 1557515936340,
    "lastUpdatedDate": 1557515936340,
    "timeZoneFormatted": "EST",
    "personCredentials": [
      {
        "credentialType": "USERNAME",
        "credential": "johndoe",
        "createdDate": 1557515936544,
        "lastUpdatedDate": 1557515936544
      }
    ],
    "personRoles": [
      {
        "role": {
          "id": 3,
          "name": "CONSUMER",
          "clientName": "JANUS",
          "description": "Consumer role",
          "clientRoleEntitlements": null
        },
        "createdDate": 1557515936644,
        "lastUpdatedDate": 1557515936644
      }
    ],
    "personContacts": [
      {
        "contactType": "EMAIL",
        "contact": "johndoe@test.com",
        "createdDate": 1557515936444,
        "lastUpdatedDate": 1557521447447
      }
    ],
    "enabled": true,
    "username": "johndoe",
    "credentialsNonExpired": true,
    "accountNonLocked": true,
    "id": "johndoe12345"
  }
}

Retrieve Logs of Audit Data - by Admin

Supply the username and audit Id to retrieve complete detail of the audit data by admin. Only administrators with the same tenant user data can be retrieved.

Precondition

Client logged in the service. Refer the section for registration/authentication. The user must have the entitlement to access this API.

Rest Basic Environment	Value
Method	GET
Resource URL	http://api-dev.fintiv.co:8080/admin/client/person/audit/{uuid}/{auditId}
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

URI Parameters

Parameter Name	DataType	Required	Description
uuid	String	Yes	Unique user identifier.
auditId	Integer	Yes	Unique identifier of the audit record.

Retrieve Logs of Audit Data by Admin Request

curl -X GET "http://localhost:8084/admin/client/person/audit/a20190404/920"
-H "accept: application/json;charset=UTF-8"
-H "tenantName: JANUS"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"

Request Parameters

None.

Retrieve Logs of Audit Data by Admin Response Returns person audit record for the specific audit ID.

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": {
    "id": 920,
    "auditCategory": "API",
    "name": "ADDSECURITYANSWER",
    "auditAction": "CREATE",
    "uuid": "a20190404",
    "createdDate": 1556147331915,
    "result": "N",
    "summary": "Add a user security answer",
    "parameter": null,
    "data": "{\"id\":0,\"uuid\":null,\"securityQuestion\":null,\"answer\":null,\"createdDate\":null,\"lastUpdatedDate\":null}",
    "errorMessage": "{\"tenantName\":null,\"statusCode\":\"VALIDATION\",\"statusMessage\":\"Failed. Please contact system admin.\",\"additionalStatusCode\":null,\"additionalStatusMessage\":null}",
    "startDate": null,
    "endDate": null,
    "clientIpAddress": "10.22.1.100, 10.128.5.29",
    "httpLoggingId": 3875,
    "httpLogging": {
      "id": 3875,
      "requestMessage": "REST Request - [HTTP METHOD:POST] [PATH INFO:/api/myinfo/securityAnswer] [host:dev-aas.int.fintiv.co] [user-agent:Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/74.0.3729.108 Safari/537.36] [content-length:2] [accept:*/*] [accept-encoding:gzip, deflate] [accept-language:en-US,en;q=0.9,ko-KR;q=0.8,ko;q=0.7] [authorization:Bearer < bearer token here> ] [content-type:application/json] [cookie:AWSALB=fJjLq83XCePztPChlJfjze/BdTeYAYYfgAEKHVmu4UyIUKVjlxqBXLIxA1uiWnj0684+rE+H5s+GplS9n5KjWWpjPMr99IiBB6SaI//Coi92gMNqzgm9sXcSeZsF] [origin:http://dev-aas.int.fintiv.co] [referer:http://dev-aas.int.fintiv.co/swagger-ui.html] [x-amzn-trace-id:Root=1-5cc0b443-3fcc504097e7e1028cb56810] [x-forwarded-for:10.22.1.100, 10.128.5.29] [x-forwarded-host:dev-aas.int.fintiv.co] [x-forwarded-port:80] [x-forwarded-proto:http] [x-forwarded-server:ore-prd-mc-cl-devtest-b01.mozido.com] [x-real-ip:10.128.5.29] [REQUEST PARAMETERS:{}] [REQUEST BODY:{}] [REMOTE ADDRESS:10.128.6.27]",
      "responseMessage": "{\"contextResponse\":{\"tenantName\":null,\"statusCode\":\"VALIDATION\",\"statusMessage\":\"Failed. Please contact system admin.\",\"additionalStatusCode\":null,\"additionalStatusMessage\":null},\"responseData\":null}",
      "createdDate": 1556147331884
    }
  }
}

Assign Role to the Tenant’s User - by Admin

Supply the person's Username and name of the role(s) assigned to the user by the admin. Only existing tenant user data can be modified.

Precondition

Client logged in the service. Refer the section for registration/authentication. The logged in user must have the permission to access the API.

Rest Basic Environment	Value
Method	POST
Resource URL	http://api-dev.fintiv.co:8080/auth/admin/client/person/role
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

Assign Role to the Tenant User by Admin Request

curl -X POST "http://api-dev.fintiv.co:8080/auth/admin/client/person/role"
-H "accept: application/json;charset=UTF-8"
-H "tenantName: JANUS"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"
-H "Content-Type: application/json"
-d ‘{"roleName":"CONSUMER","uuid":"a20190404"}’

Request Parameters

Parameter Name	Data Type	Required	Description
uuid	String	Yes	Unique user identifier.
roleName	String	Optional	Role name.

Assign Role to the Tenant User by Admin Response Returns role object assigned to the user, and includes the list of entitlement assigned to the role.

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": {
    "role": {
      "id": 3,
      "name": "CONSUMER",
      "clientName": "JANUS",
      "description": "Consumer role",
      "clientRoleEntitlements": [
        {
          "id": 7,
          "entitlement": {
            "id": 2,
            "name": "RESET_PASSWORD",
            "description": "Reset User Password",
            "createdDate": 1548189958507,
            "lastUpdatedDate": 1548189958507
          },
          "createdDate": 1548172231554,
          "lastUpdatedDate": 1548172231554,
          "authority": "RESET_PASSWORD"
        },
        {
          "id": 8,
          "entitlement": {
            "id": 3,
            "name": "RESET_PIN",
            "description": "Reset User Pin",
            "createdDate": 1548189958507,
            "lastUpdatedDate": 1548189958507
          },
          "createdDate": 1548172231632,
          "lastUpdatedDate": 1548172231632,
          "authority": "RESET_PIN"
        },
        {
          "id": 9,
          "entitlement": {
            "id": 4,
            "name": "GET_TEMPORARY_PASSWORD",
            "description": "get temporary password",
            "createdDate": 1548189958507,
            "lastUpdatedDate": 1548189958507
          },
          "createdDate": 1548172231710,
          "lastUpdatedDate": 1548172231710,
          "authority": "GET_TEMPORARY_PASSWORD"
        },
        {
          "id": 10,
          "entitlement": {
            "id": 9,
            "name": "CHANGE_PIN_PASSWORD",
            "description": "change password and pin",
            "createdDate": 1548189958507,
            "lastUpdatedDate": 1548189958507
          },
          "createdDate": 1548172231789,
          "lastUpdatedDate": 1548172231789,
          "authority": "CHANGE_PIN_PASSWORD"
        },
        {
          "id": 72,
          "entitlement": {
            "id": 27,
            "name": "DEREGISTER_ACCOUNT",
            "description": "Deregister user account",
            "createdDate": 1556288291582,
            "lastUpdatedDate": 1556288291582
          },
          "createdDate": 1556314043911,
          "lastUpdatedDate": 1556314043911,
          "authority": "DEREGISTER_ACCOUNT"
        }
      ]
    },
    "createdDate": 1558362351478,
    "lastUpdatedDate": 1558362351478
  }
}

Remove Role from the Tenant User - by Admin

Supply username and roleName for removal from the user's profile by an admin. Only the same tenant user data can be modified.

Precondition

Client logged in the service. Refer the section for registration/authentication. The logged in user must have the permission to access the API.

Rest Basic Environment	Value
Method	DELETE
Resource URL	http://api-dev.fintiv.co:8080/auth/admin/client/person/role
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

Request Parameters

Parameter Name	Data Type	Required	Description
uuid	String	Yes	Unique user identifier.
roleName	String	Yes	Role name.

Remove Role from the Tenant User by Admin

curl -X DELETE "http://api-dev.fintiv.co:8080/auth/admin/client/person/role"
-H "accept: application/json;charset=UTF-8"
-H "tenantName: JANUS"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"
-H "Content-Type: application/json"
-d ‘{"roleName":"ADMIN","uuid":"a20190404"}’

Remove Role from the Tenant User by Admin Response Returns result of the request.

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": null
}

Retrieve Tenant User Roles - by Admin

Supply Username and/or role to retrieve roles assigned to the tenant by admin. Only the same tenant user data can be retrieved.

Precondition

Client logged in the service. Refer the section for registration/authentication. The logged in user must have the permission to access the API.

Rest Basic Environment	Value
Method	GET
Resource URL	http://api-dev.fintiv.co:8080/auth/admin/client/person/role
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

Retrieve Tenant User Roles by Admin Request

curl -X GET " http://api-dev.fintiv.co:8080/auth/admin/client/person/role"
-H "accept: application/json;charset=UTF-8"
-H "tenantName: JANUS"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"
-H "Content-Type: application/json"
-d ‘{"uuid":"a20190404"}’

Request Parameters

Parameter Name	Data Type	Required	Description
uuid	String	Yes	Unique user identifier.
roleName	String	Optional	Role name.

Retrieve Tenant User Roles by Admin Response Returns the result of the role request.

{
    "contextResponse": {
        "tenantName": "JANUS",
        "statusCode": "SUCCESS",
        "statusMessage": null,
        "additionalStatusCode": null,
        "additionalStatusMessage": null
    },
    "responseData": [{
        "role": {
            "id": 3,
            "name": "CONSUMER",
            "clientName": "JANUS",
            "description": "Consumer role",
            "clientRoleEntitlements": [{
                "id": 7,
                "entitlement": {
                    "id": 2,
                    "name": "RESET_PASSWORD",
                    "description": "Reset User Password",
                    "createdDate": 1548207958507,
                    "lastUpdatedDate": 1548207958507
                },
                "createdDate": 1548190231554,
                "lastUpdatedDate": 1548190231554,
                "authority": "RESET_PASSWORD"
            }, {
                "id": 8,
                "entitlement": {
                    "id": 3,
                    "name": "RESET_PIN",
                    "description": "Reset User Pin",
                    "createdDate": 1548207958507,
                    "lastUpdatedDate": 1548207958507
                },
                "createdDate": 1548190231632,
                "lastUpdatedDate": 1548190231632,
                "authority": "RESET_PIN"
            }, {
                "id": 9,
                "entitlement": {
                    "id": 4,
                    "name": "GET_TEMPORARY_PASSWORD",
                    "description": "get temporary password",
                    "createdDate": 1548207958507,
                    "lastUpdatedDate": 1548207958507
                },
                "createdDate": 1548190231710,
                "lastUpdatedDate": 1548190231710,
                "authority": "GET_TEMPORARY_PASSWORD"
            }, {
                "id": 10,
                "entitlement": {
                    "id": 9,
                    "name": "CHANGE_PIN_PASSWORD",
                    "description": "change password and pin",
                    "createdDate": 1548207958507,
                    "lastUpdatedDate": 1548207958507
                },
                "createdDate": 1548190231789,
                "lastUpdatedDate": 1548190231789,
                "authority": "CHANGE_PIN_PASSWORD"
            }, {
                "id": 72,
                "entitlement": {
                    "id": 27,
                    "name": "DEREGISTER_ACCOUNT",
                    "description": "Deregister user account",
                    "createdDate": 1556302691582,
                    "lastUpdatedDate": 1556302691582
                },
                "createdDate": 1556328443911,
                "lastUpdatedDate": 1556328443911,
                "authority": "DEREGISTER_ACCOUNT"
            }]
        },
        "createdDate": 1554397020822,
        "lastUpdatedDate": 1554397020822
    }]
}

Lock Tenant User Account - by Admin

Lock the user account to prevent thier access to the service. Only the same tenant user data can be modified.

Precondition

Client logged in the service. Refer the section for registration/authentication. The logged in user must have the permission to access the API.

Rest Basic Environment	Value
Method	POST or PUT
Resource URL	http://api-dev.fintiv.co:8080/auth/admin/client/person/{uuid}/lock
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

URI Parameters

Parameter Name	DataType	Required	Description
uuid	String	yes	Unique User identifier.

Lock Tenant User Account by Admin Request

curl -X POST "http://api-dev.fintiv.co:8080/auth/admin/client/person/a20190404/lock"
-H "accept: application/json;charset=UTF-8"
-H "tenantName: JANUS"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"

Request Parameters

Parameter Name	Data Type	Required	Description

None.

Lock Tenant User Account by Admin Response Returns the result of the request.

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": null
}

Reset Tenant User Password - by Admin

Resets a user’s password and sends a temporary password to the user’s email address.

Precondition

Client logged in the service. Refer the section for registration/authentication. The logged in user must have the permission to access the API.

Rest Basic Environment	Value
Method	POST or PUT
Resource URL	http://api-dev.fintiv.co:8080/auth/admin/client/person/{uuid}/resetPassword
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

URI Parameters

Parameter Name	DataType	Required	Description
uuid	String	yes	Unique User identifier.

Reset Tenant User Password by Admin Request

curl -X POST "http://api-dev.fintiv.co:8080/auth/admin/client/person/a20190404/resetPassword"
-H "accept: application/json;charset=UTF-8"
-H "tenantName: JANUS"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"
-H "Content-Type: application/json"
-d ‘{"answer":"Sedona","securityQuestionId":2}’

Request Parameters

Parameter Name	Data Type	Required	Description
securityQuestionId	int	Yes	Unique ID of security question.
answer	String	Yes	Role name.

Reset Tenant User Password by Admin Response Returns result of the request.

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": null
}

Unlock Tenant User Account - by Admin

Unlock the suspended user account to allow their access to the service. Only the same tenant user data can be modified.

Precondition

Client logged in the service. Refer the section for registration/authentication. The logged in user must have the permission to access the API.

Rest Basic Environment	Value
Method	POST or PUT
Resource URL	http://api-dev.fintiv.co:8080/auth/admin/client/person/{uuid}/unlock
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

URI Parameters

Parameter Name	DataType	Required	Description
uuid	String	yes	Unique User identifier.

Unlock Tenant User Account by Admin Request

curl -X POST "http://api-dev.fintiv.co:8080/auth/admin/client/person/a20190404/unlock"
-H "accept: application/json;charset=UTF-8"
-H "tenantName: JANUS"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"

Request Parameters

Parameter Name	Data Type	Required	Description

None.

Unlock Tenant User Account by Admin Response Returns result of the request.

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": null
}

Reset Tenant User PIN - by Admin

Reset user’s PIN. The temporary password is sent to the user’s email address.

Precondition

Client logged in the service. Refer the section for registration/authentication. The logged in user must have the permission to access the API.

Rest Basic Environment	Value
Method	POST or PUT
Resource URL	http://api-dev.fintiv.co:8080/auth/admin/client/person/{uuid}/resetPin
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

URI Parameters

Parameter Name	Data Type	Required	Description
uuid	String	Yes	Unique user identifier.

Reset Tenant User PIN by Admin Request

curl -X POST "http://api-dev.fintiv.co:8080/auth/admin/client/person/a20190404/resetPin"
-H "accept: application/json;charset=UTF-8"
-H "tenantName: JANUS"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"
-H "Content-Type: application/json"
-d ‘{"answer":"Sedona","securityQuestionId":2}’

Request Parameters

Parameter Name	Data Type	Required	Description
securityQuestionId	int	Yes	Unique ID of security question.
answer	String	Yes	Role name

Reset Tenant User PIN by Admin Response Returns result of the request.

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": null
}

Create a New Role with Entitlements in the Tenant Account

Client retrieves list of skins configured on the backend.

Precondition

Client logged in the service. Refer the section for registration/authentication.

Rest Basic Environment	Value
Method	POST
Resource URL	http://api-dev.fintiv.co:8080/skin/{version}/getMySkinService
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

URI Parameters

Parameter Name	DataType	Required	Description
version	String	yes	version number

Create a new role with Entitlements in the Tenant Account Request

curl -X POST "http://api-dev.fintiv.co:8080/auth/admin/client/role"
-H "accept: application/json;charset=UTF-8"
-H "tenantName: JANUS"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"
-H "Content-Type: application/json"
-d ‘{
    "clientRoleEntitlements": [{
        "entitlement": {
            "description": "get temporary pin",
            "id": 7,
            "name": "GET_TEMPORARY_PIN"
        }
    }, {
        "entitlement": {
            "description": "Reset User Password",
            "id": 2,
            "name": "RESET_PASSWORD"
        }
    }],
    "description": "Shopper role",
    "name": "SHOPPER"
}’

Request Parameters

Parameter Name	Data Type	Required	Description
name	String	Yes	Name of new client role.
description	String	Optional	Description of new client role.
clientRoleEntitlements	clientRoleEntitlements Object Array	Yes	Entitlements assigned to the client role.

clientRoleEntitlements Object Array

Parameter Name	Data Type	Required	Description
id	integer	Yes	Unique identifier of the entitlement.
name	String	Optional	Name of entitlement.
description	String	Optional	Description of entitlement.

Create a new role with Entitlements in the Tenant Account Response Returns new role object.

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": {
    "id": 70,
    "name": "SHOPPER",
    "clientName": null,
    "description": "Shopper role",
    "clientRoleEntitlements": [
      {
        "id": 289,
        "entitlement": {
          "id": 7,
          "name": "GET_TEMPORARY_PIN",
          "description": "get temporary pin",
          "createdDate": null,
          "lastUpdatedDate": null
        },
        "createdDate": 1558458194445,
        "lastUpdatedDate": 1558458194445,
        "authority": "GET_TEMPORARY_PIN"
      },
      {
        "id": 290,
        "entitlement": {
          "id": 2,
          "name": "RESET_PASSWORD",
          "description": "Reset User Password",
          "createdDate": null,
          "lastUpdatedDate": null
        },
        "createdDate": 1558458194543,
        "lastUpdatedDate": 1558458194543,
        "authority": "RESET_PASSWORD"
      }
    ]
  }
}

Update Tenant User Account - By Admin

Update a user’s status. Only the same tenant user data can be modified.

Precondition

Client logged in the service. Refer the section for registration/authentication. The logged in user must have the permission to access the API.

Rest Basic Environment	Value
Method	POST or PUT
Resource URL	http://api-dev.fintiv.co:8080/auth/admin/client/person/{uuid}/status
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

URI Parameters

Parameter Name	DataType	Required	Description
uuid	String	yes	Unique User identifier.

Update Tenant’s User Account By Admin Response

curl -X POST "http://api-dev.fintiv.co:8080/auth/admin/client/person/a20190404/status"
-H "accept: application/json;charset=UTF-8"
-H "tenantName: JANUS"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"
-H "Content-Type: application/json" –
d "DISABLED"

Request Parameters

Parameter Name	Data Type	Required	Description
Value of person status	String	Yes	Possible values are ‘ACTIVE’, ‘INACTIVE’, and ‘LOCKED’.

Update Tenant’s User Account By Admin Response Returns result of the request.

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": null
}

Delete role by Role ID - by Admin

Supply roleId and the role is deleted in the tenant’s account.

Precondition

Client logged in the service. Refer the section for registration/authentication. The logged in user must have the permission to access the API.

Rest Basic Environment	Value
Method	DELETE
Resource URL	http://api-dev.fintiv.co:8080/auth/admin/client/role/{roleId}
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

URI Parameters

Parameter Name	DataType	Required	Description
roleId	Integer	yes	Unique Role identifier.

Delete role by Role ID Request

curl -X DELETE "http://api-dev.fintiv.co:8080/auth/admin/client/role/70"
-H "accept: application/json;charset=UTF-8"
-H "tenantName: JANUS"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"

Request Parameters

Parameter Name	Type	Required	Description

None.

Delete role by Role ID Response

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": null
}

Retrieve List of Client Roles - By admin

Retrieve list of roles created in the tenant.

Precondition

Client logged in the service. Refer the section for registration/authentication. The logged in user must have the permission to access the API.

Rest Basic Environment	Value
Method	GET
Resource URL	http://api-dev.fintiv.co:8080/auth/admin/client/role
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

Retrieve List of Client Roles Request

curl -X GET "http://api-dev.fintiv.co:8080/auth/admin/client/role"
-H "accept: application/json;charset=UTF-8"
-H "tenantName: JANUS"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"

Request Parameters

Parameter	Type	Required	Note

None.

Retrieve List of Client Roles Response Returns list of roles but without clientRoleEntitlements object. result of the request.

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": [
    {
      "id": 2,
      "name": "POS_USER",
      "clientName": "JANUS",
      "description": "POS user role",
      "clientRoleEntitlements": null
    },
    {
      "id": 3,
      "name": "CONSUMER",
      "clientName": "JANUS",
      "description": "Consumer role",
      "clientRoleEntitlements": null
    },
    {
      "id": 5,
      "name": "POS_USER101",
      "clientName": "JANUS",
      "description": null,
      "clientRoleEntitlements": null
    },
    {
      "id": 7,
      "name": "Test Role",
      "clientName": "JANUS",
      "description": "Test Role",
      "clientRoleEntitlements": null
    },
    {
      "id": 13,
      "name": "SVA_role1",
      "clientName": "JANUS",
      "description": "SVA_role1_update",
      "clientRoleEntitlements": null
    },
    {
      "id": 17,
      "name": "Role 4",
      "clientName": "JANUS",
      "description": "Test Role4",
      "clientRoleEntitlements": null
    },
    {
      "id": 32,
      "name": "test-role55",
      "clientName": "JANUS",
      "description": "test-role55",
      "clientRoleEntitlements": null
    },
    {
      "id": 6,
      "name": "ADMIN",
      "clientName": "JANUS",
      "description": "string",
      "clientRoleEntitlements": null
    },
    {
      "id": 33,
      "name": "test-role155_update",
      "clientName": "JANUS",
      "description": "test_55_update",
      "clientRoleEntitlements": null
    },
    {
      "id": 35,
      "name": "Deregister-role",
      "clientName": "JANUS",
      "description": "Deregister-role",
      "clientRoleEntitlements": null
    },
    {
      "id": 56,
      "name": "REGISTRATION_ADMIN",
      "clientName": "JANUS",
      "description": "REGISTRATION_ADMIN",
      "clientRoleEntitlements": null
    }
  ]
}

Delete Role by Role ID - by Admin

Supply roleId and delete role in the tenant’s account.

Precondition

Client logged in the service. Refer the section for registration/authentication. The logged in user must have the permission to access the API.

Rest Basic Environment	Value
Method	DELETE
Resource URL	http://api-dev.fintiv.co:8080/auth/admin/client/role/{roleId}
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

URI Parameters

Parameter Name	DataType	Required	Description
roleId	Integer	yes	Unique Role identifier.

Delete role by Role ID Request

curl -X DELETE "http://api-dev.fintiv.co:8080/auth/admin/client/role/70"
-H "accept: application/json;charset=UTF-8"
-H "tenantName: JANUS"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"

Request Parameters

Parameter Name	Type	Required	Description

None.

Delete role by Role ID Response

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": null
}

Search Role by Role ID

Supply role ID to retrieve the role details and its entitlements mapping list by tenant. Only the same tenant user data can be modified.

Precondition

Client logged in the service. Refer the section for registration/authentication. The logged in user must have the permission to access the API.

Rest Basic Environment	Value
Method	POST or PUT
Resource URL	http://api-dev.fintiv.co:8080/auth/admin/client/role/{roleId}
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

URI Parameters

Parameter Name	DataType	Required	Description
roleId	Integer	yes	Unique Role identifier.

Search role by role ID Request

curl -X POST "http://api-dev.fintiv.co:8080/auth/admin/client/role/6"
-H "accept: application/json;charset=UTF-8"
-H "tenantName: JANUS"
-H "authorization: Bearer <insert your bearer token here>"
-H "Content-Type: application/json"

Request Parameters

Parameter Name	Type	Required	Description

None.

Search role by role ID Response

{
 "contextResponse": {
   "tenantName": "JANUS",
   "statusCode": "SUCCESS",
   "statusMessage": null,
   "additionalStatusCode": null,
   "additionalStatusMessage": null
 },
 "responseData": {
   "id": 6,
   "name": "ADMIN",
   "clientName": "JANUS",
   "description": "string",
   "clientRoleEntitlements": [
     {
       "id": 62,
       "entitlement": {
         "id": 12,
         "name": "ADMIN_MANAGE_CLIENT",
         "description": "Admin - Client/Tenant management",
         "createdDate": 1549044920746,
         "lastUpdatedDate": 1549044920746
       },
       "createdDate": 1556317217146,
       "lastUpdatedDate": 1556317217146,
       "authority": "ADMIN_MANAGE_CLIENT"
     },
     {
       "id": 63,
       "entitlement": {
         "id": 13,
         "name": "ADMIN_MANAGE_CLIENT_ROLE",
         "description": "Admin - Client/Tenant role management",
         "createdDate": 1549044921025,
         "lastUpdatedDate": 1549044921025
       },
       "createdDate": 1556317283460,
       "lastUpdatedDate": 1556317283460,
       "authority": "ADMIN_MANAGE_CLIENT_ROLE"
     },
     {
       "id": 64,
       "entitlement": {
         "id": 14,
         "name": "ADMIN_MANAGE_CLIENT_USER",
         "description": "Admin - Client/Tenant user management",
         "createdDate": 1549044921257,
         "lastUpdatedDate": 1549044921257
       },
       "createdDate": 1556317284696,
       "lastUpdatedDate": 1556317284696,
       "authority": "ADMIN_MANAGE_CLIENT_USER"
     },
     {
       "id": 65,
       "entitlement": {
         "id": 15,
         "name": "ADMIN_MANAGE_CLIENT_USER_ROLE",
         "description": "Admin - Client/Tenant user role management",
         "createdDate": 1549044921493,
         "lastUpdatedDate": 1549044921493
       },
       "createdDate": 1556317286009,
       "lastUpdatedDate": 1556317286009,
       "authority": "ADMIN_MANAGE_CLIENT_USER_ROLE"
     },
     {
       "id": 66,
       "entitlement": {
         "id": 16,
         "name": "ADMIN_MANAGE_CLIENT_USER_STATUS",
         "description": "Admin - Client/Tenant user status management",
         "createdDate": 1549044921724,
         "lastUpdatedDate": 1549044921724
       },
       "createdDate": 1556317287221,
       "lastUpdatedDate": 1556317287221,
       "authority": "ADMIN_MANAGE_CLIENT_USER_STATUS"
     },
     {
       "id": 67,
       "entitlement": {
         "id": 17,
         "name": "ADMIN_MANAGE_ENTITLEMENT",
         "description": "Admin - Entitlement management",
         "createdDate": 1549656468174,
         "lastUpdatedDate": 1549656468174
       },
       "createdDate": 1556317288429,
       "lastUpdatedDate": 1556317288429,
       "authority": "ADMIN_MANAGE_ENTITLEMENT"
     },
     {
       "id": 68,
       "entitlement": {
         "id": 18,
         "name": "ADMIN_MANAGE_SECURITY_QUESTION",
         "description": "Admin - Security Question management",
         "createdDate": 1549656468513,
         "lastUpdatedDate": 1549656468513
       },
       "createdDate": 1556317289580,
       "lastUpdatedDate": 1556317289580,
       "authority": "ADMIN_MANAGE_SECURITY_QUESTION"
     },
     {
       "id": 69,
       "entitlement": {
         "id": 24,
         "name": "ADMIN_RESET_USER_PASSWORD",
         "description": "Reset client user password by Admin",
         "createdDate": 1550252655625,
         "lastUpdatedDate": 1550252655625
       },
       "createdDate": 1556317290712,
       "lastUpdatedDate": 1556317290712,
       "authority": "ADMIN_RESET_USER_PASSWORD"
     },
     {
       "id": 70,
       "entitlement": {
         "id": 25,
         "name": "ADMIN_RESET_USER_PIN",
         "description": "Reset client user pin by Admin",
         "createdDate": 1550252691367,
         "lastUpdatedDate": 1550252691367
       },
       "createdDate": 1556317291827,
       "lastUpdatedDate": 1556317291827,
       "authority": "ADMIN_RESET_USER_PIN"
     },
     {
       "id": 71,
       "entitlement": {
         "id": 27,
         "name": "DEREGISTER_ACCOUNT",
         "description": "Deregister user account",
         "createdDate": 1556302691582,
         "lastUpdatedDate": 1556302691582
       },
       "createdDate": 1556326559696,
       "lastUpdatedDate": 1556326559696,
       "authority": "DEREGISTER_ACCOUNT"
     }
   ]
 }
}

Update Role by Role ID - by Admin

Admin updates entitlements for their tenant's role.

Precondition

The Client must be logged into the service. Refer the section for registration/authentication. The logged in user must have the correct permission to access the API.

Rest Basic Environment	Value
Method	POST or PUT
Resource URL	http://api-dev.fintiv.co:8080/auth/admin/client/role/{roleId}
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

URI Parameters

Parameter Name	DataType	Required	Description
roleId	Integer	yes	Unique Role identifier.

Update Role by Role ID Requests

curl -X POST "http://api-dev.fintiv.co:8080/auth/admin/client/role/70"
-H "accept: application/json;charset=UTF-8"
-H "tenantName: JANUS"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"
-H "Content-Type: application/json"
-d ‘{
    "clientRoleEntitlements": [{
        "entitlement": {
            "description": "get temporary pin",
            "id": 7,
            "name": "GET_TEMPORARY_PIN"
        }
    }, {
        "entitlement": {
            "description": "Reset User Password",
            "id": 2,
            "name": "RESET_PASSWORD"
        }
    }, {
        "entitlement": {
            "description": "Reset User Pin",
            "id": 3,
            "name": "RESET_PIN"
        }
    }],
    "description": "Role for shopper",
    "name": "SHOPPER"
}’

Request Parameters

Parameter	Type	Required	Note
name	String	Yes	Name of new client role.
description	String	Optional	Description of new client role.
clientRoleEntitlements	entitlement	Yes	Entitlements to be assigned to the client role.

Entitlement Parameters

Parameter	Type	Required	Note
id	int	Yes	Unique identifier of the entitlement to be assigned.
name	String	Optional	Name of entitlement.
description	String	Optional	Description of entitlement.

Update Role by Role ID Response Returns result of the request.

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": {
    "id": 70,
    "name": "SHOPPER",
    "clientName": "JANUS",
    "description": "Role for shopper",
    "clientRoleEntitlements": [
      {
        "id": 291,
        "entitlement": {
          "id": 7,
          "name": "GET_TEMPORARY_PIN",
          "description": "get temporary pin",
          "createdDate": 1548207958507,
          "lastUpdatedDate": 1548207958507
        },
        "createdDate": 1558459464413,
        "lastUpdatedDate": 1558459464413,
        "authority": "GET_TEMPORARY_PIN"
      },
      {
        "id": 292,
        "entitlement": {
          "id": 2,
          "name": "RESET_PASSWORD",
          "description": "Reset User Password",
          "createdDate": 1548207958507,
          "lastUpdatedDate": 1548207958507
        },
        "createdDate": 1558459464510,
        "lastUpdatedDate": 1558459464510,
        "authority": "RESET_PASSWORD"
      },
      {
        "id": 293,
        "entitlement": {
          "id": 3,
          "name": "RESET_PIN",
          "description": "Reset User Pin",
          "createdDate": 1548207958507,
          "lastUpdatedDate": 1548207958507
        },
        "createdDate": 1558459464607,
        "lastUpdatedDate": 1558459464607,
        "authority": "RESET_PIN"
      }
    ]
  }
}

Deregister User Account

Unregister a user's account from a tenant. Admins may unregister a user registered in their tenant and a user can unregister their own account.

Precondition

Client logged in the service. Refer the section for registration/authentication. The logged in user must have the permission to access the API.

Rest Basic Environment	Value
Method	DELETE
Resource URL	http://api-dev.fintiv.co:8080/auth/api/deregister/{uuid}
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
api-key	{Your APP Key}
authorization	Bearer {access_token}

URI Parameters

Parameter Name	DataType	Required	Description
uuid	String	Yes	Unique user ID used to register.

Deregister User Account Request

curl -X DELETE "http://api-dev.fintiv.co:8080/auth /api/deregister/test043009"
-H "accept: application/json;charset=UTF-8"
-H "tenantName: JANUS"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"

Request Parameters

Parameter Name	Data Type	Required	Description

none.

Deregister User Account Response

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": null
}

Close User Account

Close a user's account. A user can deregister their own account. An admin is able to close a user's account on their tenant, if they have permission.

Precondition

None.

Rest Basic Environment	Value
Method	DELETE
Resource URL	http://api-dev.fintiv.co:8080/auth/api/deregister/{uuid}
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

| | | | | :--- | :--- | | | Content-Type | application/json | Comment| | api-key | {Your APP Key} | | authorization| Bearer {access_token} |

URI Parameters

Parameter Name	Data Type	Required	Description
uuid	String	Yes	Unique user ID used to register.

Close User Account Request

curl -X DELETE "http://api-dev.fintiv.co:8080/auth/api/deregister/test20190417"
-H "accept: application/json;charset=UTF-8"
-H "tenantName: JANUS"
-H "api-key: <insert your APP Key here>"

Request Parameters

Parameter Name	Data Type	Required	Description

none.

Close User Account Response

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": null
}

Change My Password

A logged in user changes their password by supplying their current password for validation and new password creation.

Precondition

Client logged into the service. Refer to the registration/authentication section.

Rest Basic Environment	Value
Method	POST or PUT
Resource URL	http://api-dev.fintiv.co:8080/auth/api/myinfo/changePassword
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

Change My Password Request

curl -X POST " http://api-dev.fintiv.co:8080/auth/api/myinfo/changePassword"
-H "accept: */*"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"
-H "Content-Type: application/json"
-d ‘{"currentPassword": "Test1234!", "newPassword": "Test2345!"}’

Request Parameters

Parameter Name	Type	Required	Description
currentPassword	String	Yes	Current password
newPassword	String	Yes	New password

Change My Password Response Returns result of the Request

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": null
}

Add User Security Answer

A logged in user adds their answers for the security questions on the server. The security questions and user’s answers are used to validate the user when they reset their PIN and password.

Precondition

Client must be logged into the service. Refer the section for registration/authentication.

Rest Basic Environment	Value
Method	POST
Resource URL	http://api-dev.fintiv.co:8080/auth/api/myinfo/securityAnswer
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

Add User Security Answer Request

curl -X POST " http://api-dev.fintiv.co:8080/auth/api/myinfo/securityAnswer"
-H "accept: */*"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"
-H "Content-Type: application/json"

Request Parameters

Parameter	Type	Required	Note
answer	String	Yes	Answer of the question.
securityQuestion	SecurityQuestion	Yes	Security question object.
uuid	String	Optional	Unique user ID used to register. E.g. a20190404

Security Question Parameters

Parameter	Type	Required	Note
id	long	Yes	Unique ID of the question.
question	String	Optional	Question.

Add User Security Answer Response Returns saved answer of security question.

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": {
    "id": 264,
    "uuid": "a20190404",
    "securityQuestion": {
      "id": 2,
      "question": "What was the make and model of your first car?",
      "createdDate": 1549639014630,
      "lastUpdatedDate": 1549639014630
    },
    "answer": "Santafe",
    "createdDate": 1556132079841,
    "lastUpdatedDate": 1556132079841
  }
}

Get User Security Questions

Retrieves user security questions registered for the tenant. The security questions and user’s answers are used to validate user when they want to reset their PIN and password.

Precondition

Client is logged in the service. Refer the section for registration/authentication.

Rest Basic Environment	Value
Method	GET
Resource URL	http://api-dev.fintiv.co:8080/auth/api/myinfo/securityQuestions
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

Get User Security Questions Request

curl -X GET " http://api-dev.fintiv.co:8080/auth/api/myinfo/securityQuestions"
-H "accept: */*"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"

Request Parameters

Parameter Name	Data Type	Required	Description

None.

Get User Security Questions Response Returns list of user’s answered security questions. Answers are not returned.

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": [
    {
      "id": 264,
      "uuid": "a20190404",
      "securityQuestion": {
        "id": 2,
        "question": "What was the make and model of your first car?",
        "createdDate": 1549639014630,
        "lastUpdatedDate": 1549639014630
      },
      "answer": null,
      "createdDate": 1556132079841,
      "lastUpdatedDate": 1556146644539
    },
    {
      "id": 267,
      "uuid": "a20190404",
      "securityQuestion": {
        "id": 3,
        "question": "What was the name of your elementary / primary school?",
        "createdDate": 1549639014862,
        "lastUpdatedDate": 1549639014862
      },
      "answer": null,
      "createdDate": 1556133141255,
      "lastUpdatedDate": 1556133141255
    }
  ]
}

Reset User Password

Reset a user’s password. A Temporary password is sent to user’s email.

Precondition

None.

Rest Basic Environment	Value
Method	POST
Resource URL	http://api-dev.fintiv.co:8080/skin/{version}/getMySkinService
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

Reset User Password Request

curl -X POST " http://api-dev.fintiv.co:8080/auth/api/reset/password"
-H "accept: application/json;charset=UTF-8"
-H "tenantName: JANUS"
-H "api-key: <insert your APP Key here>"
-H "Content-Type: application/json"
-d ‘{"answer":"Sedona","securityQuestionId": 2,"username":"a20190404"}’

Request Parameters

Parameter Name	Type	Required	Description
answer	String	Yes	User’s answer upon the question.
securityQuestionId	long	Yes	Unique identifier of security question.
username	String	Yes	Unique user ID used to register.

Reset User Password Response Returns result of the request.

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": null
}

Retrieve Security Questions

Retrieves a user's security questions that are registered in the tenant. The security questions and user’s answers are used to validate users when they reset their PIN and password.

Precondition

None.

Rest Basic Environment	Value
Method	GET
Resource URL	http://api-dev.fintiv.co:8080/auth/api/securityQuestions
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type
tenantName
api-key

Retrieve Security Questions Request

curl -X GET " http://api-dev.fintiv.co:8080/auth/api/securityQuestions"
-H "accept: application/json;charset=UTF-8"
-H "api-key: <insert your APP Key here>"

Request Parameters

Parameter	Type	Required	Note
none

Retrieve Security Questions Response Returns list of security questions.

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": [
    {
      "id": 2,
      "question": "What was the make and model of your first car?",
      "createdDate": 1549639014630,
      "lastUpdatedDate": 1549639014630
    },
    {
      "id": 3,
      "question": "What was the name of your elementary / primary school?",
      "createdDate": 1549639014862,
      "lastUpdatedDate": 1549639014862
    }
  ]
}

Update User’s Security Answer

A logged-in user updates their answers for security questions configured in the server. The security questions and user’s answers are used to validate the user when they want to reset their PIN and password.

Precondition

Client logged in the service. Refer the section for registration/authentication.

Rest Basic Environment	Value
Method	POST or PUT
Resource URL	http://api-dev.fintiv.co:8080/auth/api/myinfo/securityAnswer/{personSecurityAnswerId}
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

URI Parameters

Parameter	Type	Required	Note
personSecurityAnswerId	String	Yes	Unique ID of the person security answer.

Update User’s Security Answer Request

curl -X POST " http://api-dev.fintiv.co:8080/auth/api/myinfo/securityAnswer/264"
-H "accept: */*"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"
-H "Content-Type: application/json"
-d ‘{"answer":"Sedona","securityQuestion": {"id":2,"question":"What was the make and model of your first car?"}}’

Request Parameters

Parameter Name	Type	Required	Description
answer	String	Yes	Answer of the question.
securityQuestion	SecurityQuestion	Yes	Security question object.
uuid	String	Optional	Unique user ID used to register.

Security Question Parameters

Parameter Name	Type	Required	Description
id	long	Yes	Unique ID of the question.
question	String	Optional	Question.

Update User’s Security Answer Response Returns updated answer of security question.

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": {
    "id": 264,
    "uuid": "a20190404",
    "securityQuestion": {
      "id": 2,
      "question": "What was the make and model of your first car?",
      "createdDate": 1549639014630,
      "lastUpdatedDate": 1549639014630
    },
    "answer": "Sedona",
    "createdDate": 1556132079841,
    "lastUpdatedDate": 1556146644539
  }
}

Check Account Existence

Check if a username already exists on the server.

Precondition

None.

Rest Basic Environment	Value
Method	GET
Resource URL	http://api-dev.fintiv.co:8080/auth/api/checkUserExist/{username}
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

Check Account Existence Request

curl -X GET "http://api-dev.fintiv.co:8080/auth/api/checkUserExist?username=a20190404"
-H "accept: application/json;charset=UTF-8"
-H "tenantName: JANUS"
-H "api-key: <insert your APP Key here>"

Request Parameters

Parameter Name	Type	Required	Description

Check Account Existence Response Returns result of the request.

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": {
    "userExist": true
  }
}

Response Body Parameters

Parameter Name	Type	Required	Description
userExist	Boolean	Yes	"true" if the user exists, "false" if they do not.

Reset User PIN

Reset a user’s PIN. A temporary PIN is sent to user’s email.

Precondition

None.

Rest Basic Environment	Value
Method	POST
Resource URL	http://api-dev.fintiv.co:8080/auth/api/reset/pin
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

Reset User PIN Request

curl -X POST " http://api-dev.fintiv.co:8080/auth/api/reset/pin "
-H "accept: application/json;charset=UTF-8"
-H "tenantName: JANUS"
-H "api-key: <insert your APP Key here>"
-H "Content-Type: application/json"
-d ‘{"answer":"Sedona","securityQuestionId": 2,"username":"a20190404"}’

Request Parameters

Parameter	Type	Required	Note
answer	String	Yes	User’s answer upon the question.
securityQuestionId	long	Yes	Unique identifier of security question.
username	String	Yes	Unique user ID used to register.

Reset User PIN Response Returns result of the request.

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": null
}

Change my PIN

For users already logged in, they can change their PIN by supplying their current PIN for validation and create a new PIN.

Precondition

Client logged in the service. Refer the section for registration/authentication.

Rest Basic Environment	Value
Method	POST or PUT
Resource URL	http://api-dev.fintiv.co:8080/auth/api/myinfo/changePin
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

Change my PIN Request

curl -X POST " http://api-dev.fintiv.co:8080/auth/api/myinfo/changePin"
-H "accept: */*"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"
-H "Content-Type: application/json"
-d ‘{"currentPin":"026047","newPin":"1234"}’

Request Parameters

Parameter	Type	Required	Note
currentPin	String	Yes	Current PIN
newPin	String	Yes	New PIN

Change my PIN Response Returns result of the Request

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": null
}

Validate User PIN

Validates a user’s PIN if it meets PIN requirements.

Precondition

None.

Rest Basic Environment	Value
Method	POST
Resource URL	http://api-dev.fintiv.co:8080/auth/api/validate/pin
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8

Header Parameters

Content-Type	application/json
tenantName	{tenantName}
api-key	{Your APP Key}
authorization	Bearer {access_token}

Validate User PIN Request

curl -X POST " http://api-dev.fintiv.co:8080/auth/api/validate/pin"
-H "accept: application/json"
-H "Content-Type: application/json"
-H "api-key: <insert your APP Key here>"
-d ‘{"pin":"2345","uuid":"a20190404"}’

Request Parameters

Parameter	Type	Required	Note
pin	String	Yes	PIN to be validated.
uuid	String	Yes	Unique user ID used to register.

Response Parameters

Parameter	Type	Required	Note
pinValidated	boolean	Yes	True if PIN is correct. False if PIN is wrong.

Validate User PIN Response Returns result of the PIN validation.

{
  "contextResponse": {
    "tenantName": null,
    "statusCode": "SUCCESS",
    "statusMessage": null,
    "additionalStatusCode": null,
    "additionalStatusMessage": null
  },
  "responseData": {
    "pinValidated": false
  }
}

Errors

The API uses the following error codes:

Error Code	Meaning
400	Bad Request -- Your request is invalid.
401	Unauthorized -- Your API key is wrong.
403	Forbidden -- The resource requested is hidden for administrators only.
404	Not Found -- The specified resource could not be found.
405	Method Not Allowed -- You tried to access a resource with an invalid method.
406	Not Acceptable -- You requested a format that isn't json.
410	Gone -- The resource requested has been removed from our servers.
500	Internal Server Error -- We had a problem with our server. Try again later.
503	Service Unavailable -- We're temporarily offline for maintenance. Please try again later.