ABHA Redirection Integration
Redirection Request details
Request URL parameters
Refer following table for required query parameters in the redirection request.
| Parameter | Type | Description |
|---|
| ts | required | UTC timestamp formatted as ddmmyyyyhh24misss. For example, 06-Dec-2022, 10:40am, and 987 milliseconds in IST should be formatted as 061220220510987 in UTC. |
| data | required | Base64 encoded encrypted string representation of JSON formatted request details (see below for content to be encrypted). |
| iv | required | Base64 encoded random IV of 16 bytes used during encryption. Finarkein ABHA will use this to decrypt the data URL parameter and serve the request. |
| id | required | Unique identifier shared separately along with the encryption key. Encrypted as Base64(XOR) along with the ts URL parameter. |
Redirection request encrypted data fields
| Parameter | Type | Description |
|---|
| xid | required | A unique identifier for every redirection request. Format: UUID |
| applicationNo | required | Internal system/policy/offer number linked to the request. |
| onCompleteRedirectUrl | required | Upon completion of the consent journey, Finarkein ABHA frontend will redirect the user to this URL along with response parameters. Format: URI |
| altRedirectUrl | nullable | Optional redirect URL in case the customer cancels the journey; by default, onCompleteRedirectUrl is used. Format: URI |
Redirection Response details
In the response from Finarkein ABHA to your web service, below URL parameters would need to be accepted on your side.
Response URL parameters
| Parameter | Type | Description |
|---|
| ts | required | UTC timestamp formatted as ddmmyyyyhh24misss. For example, 06-Dec-2022, 10:40am, and 987 milliseconds in IST will be formatted as 061220220510987 in UTC. |
| data | required | Base64 encoded encrypted string representation of JSON formatted response details (see below for encrypted fields). |
| iv | required | Base64 encoded random IV of 16 bytes used during encryption by Finarkein ABHA. Use this to decrypt the data URL parameter and process the response. |
Response encrypted response data fields
| Parameter | Type | Description |
|---|
| xid | required | The unique identifier passed in the request for the redirection. Format: UUID |
| applicationNo | required | Internal system/policy/offer number sent in the redirection request. |
| abhaNo | nullable | ABHA Number created/verified by the user. This field is present only if status = 'SUCCESS'. |
| status | required | Status of the redirection to Finarkein ABHA journey page. Possible values are: SUCCESS, FAILED, CANCELLED. Format: Enum |