KYC API
Swiftly generates onboarding starting process for user
{userId}/launch/url{userId}/session/status{userId}/launch/urlAuthentication
Generates new onboarding session and gets onboarding url for the User
Path variables
Id of the user in PAM & Wallet
Request headers
Unique client identifier associated with the request. Must be in UUID format.
To obtain a client ID for the client application, a specific client application should be registered in the KYC platform. At this stage, the registration should be performed by the product team.
sha256(x-client-id + request-payload ?? "" + client-secret-key)
Security hash for request validation.
To obtain client secret key for the client application, a specific client application should be registered in the KYC platform. At this stage, the registration should be performed by the product team.
Responses
200 - OK HTTP status code is returned in the response when the operation is successful and onboarding URL from third party vendor was retrieved successfully
Body
Internal code, should always be success
Success message
Data object representing response for getting onboarding URL
Unique URL created for the particular user, it can be directly used to start onboarding process
Session Id populated by provider during creating new onboarding session for the user
500 - Internal Server Error HTTP status code is returned in the response when the server encounters an unexpected condition that prevents it from fulfilling the request. A detailed error message will be included in the response body along with the corresponding status code to provide information about the encountered error.
{userId}/session/statusAuthentication
Gets the status of users latest onboarding session.
Path variables
Id of the user in PAM & Wallet
Request headers
Unique client identifier associated with the request. Must be in UUID format.
To obtain a client ID for the client application, a specific client application should be registered in the KYC platform. At this stage, the registration should be performed by the product team.
sha256(x-client-id + request-payload ?? "" + client-secret-key)
Security hash for request validation.
To obtain client secret key for the client application, a specific client application should be registered in the KYC platform. At this stage, the registration should be performed by the product team.
Responses
200 - OK HTTP status code is returned in the response when the operation is successful and onboarding session status code was retrieved successfully
Body
Internal code, should always be success
Data object representing response for the onboarding session status
Onboarding session status code for particular user
Onboarding session record was created
Onboarding Url was generated successfully, but the process is not finished yet
Onboarding process was finished by user and user passed successfully
Onboarding processwas finished by user, but manual interaction is needed in order to approve or reject
Onboarding process was finished by user but failied verification
An error occurred during the onboarding process, but it wasn’t due to a specific known failure
500 - Internal Server Error HTTP status code is returned in the response when the server encounters an unexpected condition that prevents it from fulfilling the request. A detailed error message will be included in the response body along with the corresponding status code to provide information about the encountered error.
200 - OK HTTP status code is returned in the response when the operation is successful. A descriptive message confirming the successful operation will be included in the response body along with any relevant data, if applicable.
Body
Internal status code, should be always Success
A class containing the result of a message send operation
400 - The Bad Request HTTP status code is returned in the response when the operation contains invalid parameters. A detailed error message will be included in the response body along with the corresponding status code.
Body
A message providing additional information about the response.
404 - Not Found HTTP status code is returned in the response when the requested resource is not found on the server. A detailed error message will be included in the response body along with the corresponding status code.
Body
Not found status code for general purposes
Could not find provider
Requested entry does not exist
422 - Unprocessable Entity HTTP status code is returned in the response when input data validation fails
500 - Internal Server Error HTTP status code is returned in the response when the server encounters an unexpected condition that prevents it from fulfilling the request. A detailed error message will be included in the response body along with the corresponding status code to provide information about the encountered error.
Unique client identifier associated with the request. Must be in UUID format.
To obtain a client ID for the client application, a specific client application should be registered in the KYC platform. At this stage, the registration should be performed by the product team.
sha256(x-client-id + request-payload ?? "" + client-secret-key)
Security hash for request validation.
To obtain client secret key for the client application, a specific client application should be registered in the KYC platform. At this stage, the registration should be performed by the product team.
Description of internal status codes that might be returned in the code field of the response object.
A class containing the result of generating launch URL
Not found status code for general purposes
Could not find provider
Requested entry does not exist