Quick Start

Authentication service generates and provides token to authenticate your application and end user. Some of its API such as reset PIN, reset password, etc. do not require token, however other APIs will require token to validate your access control and store user data. Please refer user authentication and registration for this login process.

Get an APP Key

To use some of Authentiation API, you must include a free APP key when making a request to the API. Follow the instructions in the guide to obtaining an APP key if you have not done. Use the APP Key in the header with ‘api-key’ param name.

Request

Forming the URL
The URL for the offer request is as follows:
https://api-dev.fintiv.co:8080/auth/{service_api}
Where:

• {service_api} is path of API.

Header

Attribute	Description
api-key	APP key to authenticate requests. You can view your APP keys in the dashboard
Content-Type	application/json

Example body message
Body message should be JSON format.

{"currentPassword": "Test1234!", "newPassword": "Test2345!"}

Response

Authentication service returns response as json format. If the request is successfully processed, the return includes the contextResponse for result of the request and responseData. StatusCode of success if ‘SUCCESS’. If the statusCode is other than ‘SUCCESS’, it is an error.

HTTP status code
200
Example body response message

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

Errors

Authentication service uses conventional HTTP response codes as well as internal error to indicate the error detail.

HTTP Status code

HTTP Status code summary

Code	Meaning	Description
200	OK	Used for both success and internal failure. For internal failure result code will be different from 0. Check the error mapping table for detail.
400	Bad Request	The request was unacceptable.
401	Unauthorized	No valid API Key provided No valid authorization provided
404	Not found	The requested resource doesn’t exist
500, 502	Server Errors	Something went wrong on the Fintiv backend.

Internal error code

If the Authentication service fails to process your request, it returns an internal error code which details the reason of error so you can handle error more efficiently by reading the statusCode.

HTTP status code
200
Example body response message

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "VALIDATION",
    "statusMessage": "The provided data in request body is not valid!",
    "additionalStatusCode": null,
    "additionalStatusMessage": "You can't access different user's security information."
  },
  "responseData": null
}

{
  "contextResponse": {
    "tenantName": "JANUS",
    "statusCode": "VALIDATION",
    "statusMessage": "The request parameters were not valid!",
    "additionalStatusCode": null,
    "additionalStatusMessage": "The request test20190417 does not exist!"
  },
  "responseData": null
}