KRA Microservice Repush API

Introduction

This document details the API endpoint for the KRA Microservice repush process, aimed at re-submitting onboarding information for investors. This functionality is critical for addressing instances where initial submissions fail or require re-submission. The API is a component of the KRA Microservice-preproduction platform, managed by Signzy.

Endpoint Description

URL

Production: https://backops-investor-onboarding-preproduction.signzy.tech/kra-handler/api/onboardings/repush

Pre-prod: https://backops-investor-onboarding-preproduction.signzy.tech/kra-handler/api/onboardings/repush

Method

POST: This endpoint is designed to re-push the onboarding data for a specific investor identified by their onboarding ID.

Headers

Content-Type: application/json - Indicates JSON formatted request body.
Accept: application/json - Specifies the response format expected to be JSON.
Authorization: Bearer <token> - Authenticates the request. Replace <token> with your actual bearer token.

Request Body

The request body must be a JSON object containing the following key-value pair:

onboardingId: A string representing the unique identifier of the investor's onboarding session. This ID is critical for identifying the specific onboarding data to be re-pushed.

Sample Request Body

{
 "onboardingId": "65xxxxxx9b"
}

cURL Example

Below is a cURL command example to use this API, including all required headers and the sample request body:

curl --location 'https://backops-investor-onboarding-preproduction.signzy.tech/kra-handler/api/onboardings/repush' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <your_access_token>' \
--data '{
    "onboardingId" : "65xxxxxx9b"
}'

Note: Replace <your_access_token> with your actual bearer token.

Response

The API response will contain details about the success or failure of the re-push operation. In case of success, it might return the updated status of the onboarding process or a confirmation message. For failures, an error message detailing the reason will be provided.

Sample Response

{
 "onboardingId": "65xxxxxx19",
 "customerId": "65xxxxxxbd",
 "callbackUrl": "",
 "message": "The application is in progress, and it has been repushed to KRA"
}

Error Handling

Ensure the onboardingId is correctly formatted and that the bearer token is valid and not expired.
Handle HTTP status codes properly, especially client-side (4xx) and server-side (5xx) errors.

Security

Use HTTPS to secure data during transmission.
Authentication via bearer token is required and must be safeguarded against unauthorized access.

Conclusion

The KRA Microservice Repush API is essential for maintaining the reliability of the investor onboarding process, allowing for the necessary re-submission of onboarding data. Proper implementation and diligent error handling are crucial for a smooth onboarding experience.

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected].