Task #1801
openEpic #1799: Finance Module API Integration (End-to-End)
User Story #1800: Bridge Api Intregration
Integrate KYC Link Generation API in Customer Management Module
0%
Description
Integrate the KYC Link generation API in the Customer Management module to create a KYC onboarding link for a customer. This API will be used to initiate the KYC process by sending customer details such as full name, email, customer type, and required endorsements.
The generated KYC link will support customer verification and compliance workflows.
API Details:
Endpoint: POST /kyc_links/{username}
Example:
POST /kyc_links/test_bmp_7456345352334242
Request Body:
{
"full_name": "test_bmp_7456345352334242 user",
"email": "test_bmp_7456345352334242@yopmail.com",
"type": "individual",
"endorsements": ["base", "sepa", "spei", "pix"]
}
Scope of Work:
Integrate KYC link generation API
Pass dynamic username in endpoint
Send required payload fields:
full_name
email
type
endorsements
Handle success and failure responses
Store or display generated KYC link in UI
Connect API with Customer Management flow
Tasks:
Create API service method for KYC link generation
Pass username dynamically in API path
Build request model for payload
Map API response into frontend model
Handle validation for required fields
Show success state when KYC link is generated
Show error message for failed request
Integrate generated KYC link into customer flow
Test API using valid and invalid payloads
Acceptance Criteria:
KYC link API is integrated successfully
Username is passed correctly in endpoint
Required customer data is submitted correctly
KYC link is returned and handled properly
Validation errors are shown clearly
API failure cases are handled gracefully
Dependencies:
Customer Management module
Backend KYC service availability
Auth/security headers if required by backend