# generated: 2026-07-18 # method: searched # source: https://docs.credilinq.ai/ (ReadMe reference pages, per-operation OpenAPI blocks merged) openapi: 3.0.0 info: title: CrediLinq API description: 'CrediLinq embedded finance API: B2B PayLater and GMV Financing for platforms and marketplaces. Covers Auth0 token generation, merchant onboarding and eligibility, customer and director KYC, credit line and loan (drawdown) management, payments and reconciliation, reporting, and demographic reference data.' version: '1.0' contact: name: CrediLinq Support email: support@credilinq.ai url: https://docs.credilinq.ai/ servers: - url: https://sandbox-api.credilinq.ai description: Sandbox - url: https://stage-api.credilinq.ai description: Staging - url: https://api.credilinq.ai description: Production paths: /v1/auth/generate-token: post: operationId: AuthenticationController_generateToken summary: Generate Token description: '' parameters: - name: accept-language in: header description: 'Language of the response, supported languages: en-us, in' schema: type: string default: en-us requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GenerateTokenDto' responses: '200': description: Token Generated Successfully content: application/json: schema: $ref: '#/components/schemas/GenerateTokenSuccessResponse' '400': description: Invalid Request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' tags: - Authentication /v1/onboarding/check-eligibility: post: operationId: OnboardingController_initiateOnboardingApplication summary: Check Eligibility description: '' parameters: - name: accept-language in: header description: 'Language of the response, supported languages: en-us, in' schema: type: string default: en-us requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/InitiateAppDTO' responses: '200': description: Eligibility Checked and application initiated content: application/json: schema: $ref: '#/components/schemas/CheckEligibilityResponse' '400': description: Invalid Request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '401': description: Invalid credentials content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - Onboarding security: - access-token: [] /v1/onboarding/initiate-data-processing: post: operationId: OnboardingController_initiateDaraProcessing summary: Initiate Data Processing description: '' parameters: - name: accept-language in: header description: 'Language of the response, supported languages: en-us, in' schema: type: string default: en-us requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/InitiateDataProcessingDTO' responses: '200': description: Data processing Initiated. content: application/json: schema: $ref: '#/components/schemas/DataProcessingResponse' '400': description: Invalid Request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '401': description: Invalid credentials content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '404': description: Requested Data Not Found content: application/json: schema: $ref: '#/components/schemas/ApplicationNotFoundResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - Onboarding security: - access-token: [] /v1/onboarding/send-agreement: post: operationId: OnboardingController_generateKycDocusign summary: Send Loan Agreement description: '' parameters: - name: accept-language in: header description: 'Language of the response, supported languages: en-us, in' schema: type: string default: en-us requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SendAgreementDto' responses: '200': description: Email sent content: application/json: schema: $ref: '#/components/schemas/AgreementEmailResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '401': description: Invalid credentials content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '404': description: Application not found content: application/json: schema: $ref: '#/components/schemas/ApplicationNotFoundResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - Onboarding security: - access-token: [] /v2/kyc/customer/create: post: operationId: KycController_createCustomerKYCV2 summary: Initiate Customer KYC description: '' parameters: - name: accept-language in: header description: 'Language of the response, supported languages: en-us, in' schema: type: string default: en-us requestBody: required: true content: multipart/form-data: schema: $ref: '#/components/schemas/AddBusinessKycDTO' responses: '200': description: Customer KYC Created content: application/json: schema: $ref: '#/components/schemas/CustomerKYCResponse' '401': description: Invalid credentials content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - KYC security: - access-token: [] /v2/kyc/customer/update: put: operationId: KycController_updateCustomerKYCV2 summary: Update Customer KYC description: '' parameters: - name: accept-language in: header description: 'Language of the response, supported languages: en-us, in' schema: type: string default: en-us requestBody: required: true content: multipart/form-data: schema: $ref: '#/components/schemas/UpdateBusinessKycDTO' responses: '200': description: Customer KYC Updated content: application/json: schema: $ref: '#/components/schemas/CustomerKYCResponse' '401': description: Invalid credentials content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - KYC security: - access-token: [] /v2/kyc/director/create: post: operationId: KycController_addDirectorKycV2 summary: Initiate Director KYC description: '' parameters: - name: accept-language in: header description: 'Language of the response, supported languages: en-us, in' schema: type: string default: en-us requestBody: required: true content: multipart/form-data: schema: $ref: '#/components/schemas/AddDirectorKycDTO' responses: '200': description: Director KYC Created content: application/json: schema: $ref: '#/components/schemas/DirectorKYCResponse' '401': description: Invalid credentials content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - KYC security: - access-token: [] /v2/kyc/director/update: put: operationId: KycController_updateDirectorInformationV2 summary: Update Director KYC description: '' parameters: - name: accept-language in: header description: 'Language of the response, supported languages: en-us, in' schema: type: string default: en-us requestBody: required: true content: multipart/form-data: schema: $ref: '#/components/schemas/UpdateDirectorKycDTO' responses: '200': description: Director KYC Updated content: application/json: schema: $ref: '#/components/schemas/DirectorKYCResponse' '401': description: Invalid credentials content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - KYC security: - access-token: [] /v1/kyc/send-for-review: post: operationId: KycController_sendKycForReview summary: Send KYC For Review description: '' parameters: - name: accept-language in: header description: 'Language of the response, supported languages: en-us, in' schema: type: string default: en-us requestBody: required: true content: multipart/form-data: schema: $ref: '#/components/schemas/SendForKycReviewDto' responses: '200': description: KYC Sent For Review content: application/json: schema: $ref: '#/components/schemas/KycApprovalSubmitResponse' '401': description: Invalid credentials content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - KYC security: - access-token: [] /v1/kyc/details/{applicationId}: get: operationId: KycController_getKycData summary: Get KYC Data description: '' parameters: - name: accept-language in: header description: 'Language of the response, supported languages: en-us, in' schema: type: string default: en-us - name: applicationId required: true in: path description: Application Id. It's a unique number with a combination of alphabets, numeric and some special characters like dash, hash, ampersand and forward slash. allowEmptyValue: false example: d8eb1219-gg24-4773-97d8-b05264621e60 schema: type: string responses: '200': description: Get KYC Data content: application/json: schema: $ref: '#/components/schemas/KYCDetailsResponse' '401': description: Invalid credentials content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - KYC security: - access-token: [] /v1/kyc/individual/create: post: operationId: KycController_createIndividualCustomerKYC summary: Initiate Individual KYC description: '' parameters: - name: accept-language in: header description: 'Language of the response, supported languages: en-us, in' schema: type: string default: en-us requestBody: required: true content: multipart/form-data: schema: $ref: '#/components/schemas/AddIndividualKycDTO' responses: '200': description: Individual KYC Created content: application/json: schema: $ref: '#/components/schemas/IndividualCustomerKYCResponse' '401': description: Invalid credentials content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - KYC security: - access-token: [] /v1/kyc/individual/update: put: operationId: KycController_updateIndividualCustomerKYC summary: Update Individual KYC description: '' parameters: - name: accept-language in: header description: 'Language of the response, supported languages: en-us, in' schema: type: string default: en-us requestBody: required: true content: multipart/form-data: schema: $ref: '#/components/schemas/UpdateIndividualKycDTO' responses: '200': description: Individual KYC Updated content: application/json: schema: $ref: '#/components/schemas/IndividualCustomerKYCResponse' '401': description: Invalid credentials content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - KYC security: - access-token: [] /v1/customer/{customerReferenceNo}/payment-methods: get: operationId: ClientController_getCustomerChosenPaymentMethods summary: Get Payment Methods description: '' parameters: - name: accept-language in: header description: 'Language of the response, supported languages: en-us, in' schema: type: string default: en-us - name: customerReferenceNo required: true in: path schema: type: string responses: '200': description: Get Payment Methods content: application/json: schema: $ref: '#/components/schemas/CustomerChosenPaymentsResponse' '400': description: Invalid Request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '401': description: Invalid credentials content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '404': description: Requested Data Not Found content: application/json: schema: $ref: '#/components/schemas/CustomerNotFoundResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - Customers security: - access-token: [] /v1/customer/{customerReferenceNo}/line-details: get: operationId: ClientController_getCustomerCreditLineDetails summary: Get Creditline Summary description: '' parameters: - name: accept-language in: header description: 'Language of the response, supported languages: en-us, in' schema: type: string default: en-us - name: customerReferenceNo required: true in: path schema: type: string responses: '200': description: Customer's credit line summary details content: application/json: schema: $ref: '#/components/schemas/CreditLineResponse' '400': description: Invalid Request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '401': description: Invalid credentials content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '404': description: Requested Data Not Found content: application/json: schema: $ref: '#/components/schemas/CustomerNotFoundResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - Customers security: - access-token: [] /v1/customer/{customerReferenceNo}/loans: get: operationId: ClientController_getCustomerActiveLoans summary: Get Active Loans description: '' parameters: - name: accept-language in: header description: 'Language of the response, supported languages: en-us, in' schema: type: string default: en-us - name: customerReferenceNo required: true in: path schema: type: string responses: '200': description: Get customer's active loans content: application/json: schema: $ref: '#/components/schemas/CustomerActiveLoansResponse' '400': description: Invalid Request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '401': description: Invalid credentials content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '404': description: Requested Data Not Found content: application/json: schema: $ref: '#/components/schemas/CustomerNotFoundResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - Customers security: - access-token: [] /v1/customer/holidays/{customerReferenceNo}: get: operationId: ClientController_getHolidaysByCustomer summary: Get list of Holidays by customer description: '' parameters: - name: accept-language in: header description: 'Language of the response, supported languages: en-us, in' schema: type: string default: en-us - name: customerReferenceNo required: true in: path schema: type: string - name: startDate required: false in: query description: Start Date example: '2024-04-01' schema: type: string - name: endDate required: false in: query description: End Date example: '2024-04-30' schema: type: string responses: '200': description: Get list of holidays content: application/json: schema: $ref: '#/components/schemas/HolidayListResponse' '400': description: Invalid Request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '401': description: Invalid credentials content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '404': description: Requested Data Not Found content: application/json: schema: $ref: '#/components/schemas/CustomerNotFoundResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - Customers security: - access-token: [] /v1/loan/calculateloanschedule: post: operationId: DrawdownController_calculateRepaymentScheduleBNPL summary: Preview Loan description: '' parameters: - name: accept-language in: header description: 'Language of the response, supported languages: en-us, in' schema: type: string default: en-us requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CalculateLoanScheduleV1Dto' responses: '200': description: Preview Your Loan Details content: application/json: schema: $ref: '#/components/schemas/GetCalculateLoanResponse' '400': description: Invalid Request content: application/json: schema: $ref: '#/components/schemas/BadRequestDrawdownResponse' '401': description: Invalid credentials content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '404': description: Requested Data Not Found content: application/json: schema: $ref: '#/components/schemas/CustomerNotFoundResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - Loans security: - access-token: [] /v1/loan: post: operationId: DrawdownController_createDrawdownBNPL summary: Create Loan description: '' parameters: - name: accept-language in: header description: 'Language of the response, supported languages: en-us, in' schema: type: string default: en-us - name: idempotency-key in: header description: Idempotency Key for retries schema: type: string default: '' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateLoanV1Dto' responses: '200': description: Loan created successfully content: application/json: schema: $ref: '#/components/schemas/CreateDrawdownResponse' '400': description: Invalid Request content: application/json: schema: $ref: '#/components/schemas/BadRequestDrawdownResponse' '401': description: Invalid credentials content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '404': description: Requested Data Not Found content: application/json: schema: $ref: '#/components/schemas/CustomerNotFoundResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - Loans security: - access-token: [] /v1/loan/disburse: post: operationId: DrawdownController_disburseDrawdownBNPL summary: Disburse loan description: '' parameters: - name: accept-language in: header description: 'Language of the response, supported languages: en-us, in' schema: type: string default: en-us requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DisburseLoanDto' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DisburseDrawdownResponse' '400': description: Invalid Request content: application/json: schema: $ref: '#/components/schemas/BadRequestDrawdownResponse' '401': description: Invalid credentials content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '404': description: Requested Data Not Found content: application/json: schema: $ref: '#/components/schemas/DrawdownNotFoundResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - Loans security: - access-token: [] /v1/loan/summary/{loanId}: get: operationId: DrawdownController_getDrawdownBNPL summary: Loan Summary description: '' parameters: - name: accept-language in: header description: 'Language of the response, supported languages: en-us, in' schema: type: string default: en-us - name: loanId required: true in: path schema: type: string responses: '200': description: Loan summary details content: application/json: schema: $ref: '#/components/schemas/GetLoanSummaryResponse' '401': description: Invalid credentials content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '404': description: Requested Data Not Found content: application/json: schema: $ref: '#/components/schemas/DrawdownNotFoundResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - Loans security: - access-token: [] /v1/payments/loan/initiate-payment: post: operationId: PaymentsController_initiatePaymentBNPLV1 summary: Initiate payment description: '' parameters: - name: accept-language in: header description: 'Language of the response, supported languages: en-us, in' schema: type: string default: en-us - name: idempotency-key in: header description: Idempotency Key for retries schema: type: string default: '' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/MakeLoanPaymentV1Dto' responses: '200': description: Loan Payment Done Successfully content: application/json: schema: $ref: '#/components/schemas/MakeLoanPaymentResponse' '400': description: Invalid Request content: application/json: schema: $ref: '#/components/schemas/BadRequestDrawdownResponse' '401': description: Invalid credentials content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - Payment security: - access-token: [] /v1/payments/loan/make-payment: post: operationId: PaymentsController_makePaymentBNPLV1 summary: Make payment description: '' parameters: - name: accept-language in: header description: 'Language of the response, supported languages: en-us, in' schema: type: string default: en-us - name: idempotency-key in: header description: Idempotency Key for retries schema: type: string default: '' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/MakeLoanPaymentV1Dto' responses: '200': description: Loan Payment done and verify Successfully content: application/json: schema: $ref: '#/components/schemas/MakeLoanPaymentResponse' '400': description: Invalid Request content: application/json: schema: $ref: '#/components/schemas/BadRequestDrawdownResponse' '401': description: Invalid credentials content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - Payment security: - access-token: [] /v1/payments/loans/reconcilepayment: post: operationId: PaymentsController_verifyPaymentBNPL summary: Reconcile payment description: '' parameters: - name: accept-language in: header description: 'Language of the response, supported languages: en-us, in' schema: type: string default: en-us requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/VerifyPaymentV1Dto' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/VerifyLoanPaymentsResponse' '400': description: Invalid Request content: application/json: schema: $ref: '#/components/schemas/BadRequestDrawdownResponse' '401': description: Invalid credentials content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '404': description: Requested Data Not Found content: application/json: schema: $ref: '#/components/schemas/DrawdownNotFoundResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - Payment security: - access-token: [] /v1/payments/loans/payment/{loanId}: get: operationId: PaymentsController_getAllPaymentsV1 summary: Payment History description: '' parameters: - name: accept-language in: header description: 'Language of the response, supported languages: en-us, in' schema: type: string default: en-us - name: loanId required: true in: path schema: type: string responses: '200': description: All Loan Payments content: application/json: schema: $ref: '#/components/schemas/GetLoanPaymentsResponse' '400': description: Invalid Request content: application/json: schema: $ref: '#/components/schemas/BadRequestDrawdownResponse' '401': description: Invalid credentials content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '404': description: Requested Data Not Found content: application/json: schema: $ref: '#/components/schemas/DrawdownNotFoundResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - Payment security: - access-token: [] /v1/reports/partner/partner-report: get: operationId: ReportController_getPartnerReport summary: Get Partner Report description: '' parameters: - name: accept-language in: header description: 'Language of the response, supported languages: en-us, in' schema: type: string default: en-us requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetPartnerReportDTO' responses: '200': description: Partner's Report Details content: application/json: schema: $ref: '#/components/schemas/GetPartnerDashboardResponse' '400': description: Invalid Request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '401': description: Invalid credentials content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '404': description: Requested Data Not Found content: application/json: schema: $ref: '#/components/schemas/PartnerNotFoundResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - Report security: - access-token: [] /v1/reports/customer/{customerReferenceNo}/dashboard: get: operationId: ReportController_getClientDashboardData summary: Get Customer Dashboard description: '' parameters: - name: accept-language in: header description: 'Language of the response, supported languages: en-us, in' schema: type: string default: en-us - name: customerReferenceNo required: true in: path schema: type: string responses: '200': description: Customer's Dashboard Details content: application/json: schema: $ref: '#/components/schemas/GetCustomerDashboardResponse' '400': description: Invalid Request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '401': description: Invalid credentials content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '404': description: Requested Data Not Found content: application/json: schema: $ref: '#/components/schemas/CustomerNotFoundResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - Report security: - access-token: [] /v1/reports/credit-history/{customerReferenceNo}: get: operationId: ReportController_GetAllCreditHistoryByRefNo summary: Get Credit History description: '' parameters: - name: accept-language in: header description: 'Language of the response, supported languages: en-us, in' schema: type: string default: en-us - name: customerReferenceNo required: true in: path schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetAllCreditHistoryResponse' '400': description: Invalid Request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '401': description: Invalid credentials content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '404': description: Customer Not Found content: application/json: schema: $ref: '#/components/schemas/CustomerNotFoundResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - Report security: - access-token: [] /v1/others/demographic-info/postal-codes: get: operationId: OthersController_getPostalCodes summary: Get Postal Codes description: '' parameters: - name: country required: true in: query example: indonesia description: Country Name schema: default: '' type: string responses: '200': description: Country wise postal codes content: application/json: schema: $ref: '#/components/schemas/GetPostalCodesResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - Miscellaneous /v1/others/demographic-info/countries: get: operationId: OthersController_getCountries summary: Get Countries description: '' parameters: [] responses: '200': description: Available Countries content: application/json: schema: $ref: '#/components/schemas/GetCountriesResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - Miscellaneous /v1/others/demographic-info/addresses: get: operationId: OthersController_getFullAddresses summary: Get Addresses description: '' parameters: - name: country required: true in: query example: indonesia description: Country Name schema: default: '' type: string - name: postalCode required: true in: query example: '95765' description: Postal Code schema: default: '' type: string responses: '200': description: Address details by country and postal code content: application/json: schema: $ref: '#/components/schemas/GetAddressResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - Miscellaneous /v1/others/kyc/document-types: get: operationId: OthersController_getKycDocumentType summary: Get Document Types description: '' parameters: - name: entityType required: false in: query description: 'Entity type. - Should be one of below values.' example: business schema: enum: - business - director - individual type: string - name: entityTypeIn required: false in: query description: 'Entity type. - Should be one of below values.' example: - business - director - individual schema: type: array items: type: string enum: - business - director - individual - name: country required: true in: query example: indonesia description: Country Name schema: default: '' type: string responses: '200': description: Get All Document Types of a Country and Entity Type content: application/json: schema: $ref: '#/components/schemas/GetDocumentTypesResponse' '403': description: Forbidden resource content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '500': description: Internal Server Error, Some problem is there, please try after sometime content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' tags: - Miscellaneous components: schemas: GenerateTokenDto: type: object properties: client_id: type: string description: Provide Client ID shared with you example: 2Hancbwhybyfy2nusfbuwbuwb client_secret: type: string description: Provide Client Secret shared with you example: y6tydyy-swfnv34-fnjjnve_eknk required: - client_id - client_secret TokenResponse: type: object properties: access_token: type: string default: description: Access-Token, which will be used for all operations scope: type: string default: description: Scope of the access-token expires_in: type: number default: 200000 description: Expiry of the access-token token_type: type: string default: Bearer description: Access-Token type required: - access_token - scope - expires_in - token_type GenerateTokenSuccessResponse: type: object properties: statusCode: type: number default: 200 description: The HTTP status code of the error data: description: Response Data from the operation allOf: - $ref: '#/components/schemas/TokenResponse' message: type: string default: Success description: Human-readable message containing all available details about the operation success: type: boolean default: true description: A boolean indicating whether this was a success response or an error response required: - statusCode - data - message - success BadRequestResponse: type: object properties: statusCode: type: number default: 400 description: The HTTP status code of the error error: type: string default: string description: Human-readable generic error message errorCode: type: string default: E_BAD_REQUEST description: Computer-readable code for error handling message: type: string default: string description: Human-readable error message containing all available details about how the error occurred success: type: boolean default: false description: A boolean indicating whether this was a success response or an error response required: - statusCode - error - errorCode - message - success ForbiddenResponse: type: object properties: statusCode: type: number default: 403 description: The HTTP status code of the error error: type: string default: string description: Human-readable generic error message errorCode: type: string default: E_FORBIDDEN description: Computer-readable code for error handling message: type: string default: string description: Human-readable error message containing all available details about how the error occurred success: type: boolean default: false description: A boolean indicating whether this was a success response or an error response required: - statusCode - error - errorCode - message - success InternalErrorResponse: type: object properties: statusCode: type: number default: 500 description: The HTTP status code of the error error: type: string default: string description: Human-readable generic error message errorCode: type: string default: E_INTERNAL_ERROR description: Computer-readable code for error handling message: type: string default: string description: Human-readable error message containing all available details about how the error occurred success: type: boolean default: false description: A boolean indicating whether this was a success response or an error response required: - statusCode - error - errorCode - message - success InitiateAppDTO: type: object properties: customerReferenceNo: type: string maxLength: 100 default: '' example: c3eb1619-ff24-4773-97d8-b05264621e60 description: "Customer Reference Number of company/business assigned by the platform to uniquely identify the customer.\ \ It's a unique number with a combination of alphabets, numeric and some special characters like dash, hash, ampersand\ \ and forward slash.\n - ``` /(^[a-zA-Z0-9#/-]+)$/ ```" customerName: type: string maxLength: 200 description: "Customer or a Company's Full Name\n - ``` /^[a-zA-Z][a-zA-Z0-9-@.'_/#&+ws]*$ ```" example: John Doe customerEmail: type: string maxLength: 75 description: "Email address of Customer/company\n \n - Should be valid email." example: johndoe2@gmail.com dataConsentProvided: type: boolean description: 'Consent to access platform data. Possible values : true/false' default: true requiredLoanAmount: type: number example: 100000 description: Required loan amount required: - customerReferenceNo - customerName - customerEmail - dataConsentProvided - requiredLoanAmount NewAppResponse: type: object properties: applicationId: type: string description: An unique id for application default: string required: - applicationId CheckEligibilityResponse: type: object properties: statusCode: type: number default: 200 description: The HTTP status code of the error data: description: Response Data from the operation allOf: - $ref: '#/components/schemas/NewAppResponse' message: type: string default: Success description: Human-readable message containing all available details about the operation success: type: boolean default: true description: A boolean indicating whether this was a success response or an error response required: - statusCode - data - message - success UnauthorizedResponse: type: object properties: statusCode: type: number default: 401 description: The HTTP status code of the error error: type: string default: string description: Human-readable generic error message errorCode: type: string default: E_UNAUTHORIZED description: Computer-readable code for error handling message: type: string default: string description: Human-readable error message containing all available details about how the error occurred success: type: boolean default: false description: A boolean indicating whether this was a success response or an error response required: - statusCode - error - errorCode - message - success InitiateDataProcessingDTO: type: object properties: customerReferenceNo: type: string maxLength: 100 default: '' example: c3eb1619-ff24-4773-97d8-b05264621e60 description: "Customer Reference Number of company/business assigned by the platform to uniquely identify the customer.\ \ It's a unique number with a combination of alphabets, numeric and some special characters like dash, hash, ampersand\ \ and forward slash.\n - ``` /(^[a-zA-Z0-9#/-]+)$/ ```" dataCycle: type: string description: "\nData Cycles.\n \n We support these two data cycles,\n \n 1. ```monitoring``` - Monitoring\n\ \ \n 2. ```origination``` - Origination" enum: - monitoring - origination example: monitoring datasetType: type: string description: "\nDataset Types.\n \n We support these two dataset types,\n \n 1. ```single``` - Single Operation\n\ \ \n 2. ```batch``` - Batch Operation" enum: - single - batch example: single fileNames: description: File Names example: - tenant_456.xlsx type: array items: type: string s3Paths: description: Data Location S3 Paths example: - https:// type: array items: type: string noOfFilesUploaded: type: number description: "No. of files uploaded on the data location\n - ```Min=2 & Max=100000```." example: 24 additionalFields: type: object description: Additional Fields for Data Processing required: - customerReferenceNo - dataCycle - datasetType - fileNames - s3Paths - noOfFilesUploaded - additionalFields DataProcessingStatusResponse: type: object properties: dataProcessingId: type: string default: string description: An unique id for Data Processing required: - dataProcessingId DataProcessingResponse: type: object properties: statusCode: type: number default: 200 description: The HTTP status code of the error data: description: Response Data from the operation allOf: - $ref: '#/components/schemas/DataProcessingStatusResponse' message: type: string default: Success description: Human-readable message containing all available details about the operation success: type: boolean default: true description: A boolean indicating whether this was a success response or an error response required: - statusCode - data - message - success ApplicationNotFoundResponse: type: object properties: statusCode: type: number default: 404 description: The HTTP status code of the error error: type: string default: string description: Human-readable generic error message errorCode: type: string default: E_O_APPLICATION_NOT_FOUND description: Computer-readable code for error handling message: type: string default: string description: Human-readable error message containing all available details about how the error occurred success: type: boolean default: false description: A boolean indicating whether this was a success response or an error response required: - statusCode - error - errorCode - message - success SendAgreementDto: type: object properties: customerReferenceNo: type: string maxLength: 100 default: '' example: c3eb1619-ff24-4773-97d8-b05264621e60 description: "Customer Reference Number of company/business assigned by the platform to uniquely identify the customer.\ \ It's a unique number with a combination of alphabets, numeric and some special characters like dash, hash, ampersand\ \ and forward slash.\n - ``` /(^[a-zA-Z0-9#/-]+)$/ ```" required: - customerReferenceNo AgreementEmailResponse: type: object properties: statusCode: type: number default: 200 description: The HTTP status code of the error data: type: string description: Agreent sent status of application. message: type: string default: Success description: Human-readable message containing all available details about the operation success: type: boolean default: true description: A boolean indicating whether this was a success response or an error response required: - statusCode - data - message - success AddBusinessKycDTO: type: object properties: customerReferenceNo: type: string default: '' example: c3eb1619-ff24-4773-97d8-b05264621e60 description: Customer reference number customerName: type: string description: "Customer or a Company's Full Name.\n - ``` /^(?:(?=^.*([0-9]|[a-z]|[A-Z]))(([0-9]|[a-z]|[A-Z]))|([0-9]|[a-z]|[A-Z]))/g\ \ ```\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" default: '' example: John Doe customerEmail: type: string description: "Email address of Customer/company which is used for login to B2B PayLater portal.\n \n - Email\ \ address which was used to check eligibility and initiate application. \n \n - Should be valid email." example: johndoe2@gmail.com default: '' companyRegistrationNo: type: string default: '' example: 1111111ET description: "Registration number with which company is registered.\n - ``` /^[A-Za-z0-9/-]+$/ ```" companyRegistrationDate: type: string description: Company Registration Date is a date at which company is registered. Supported Date Formats (DD-MM-YYYY/DD MMM YYYY) example: 13-07-2023 default: '' incorporationCountry: type: string default: '' example: Singapore description: "Country of incorporation for company.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" industry: type: string default: '' enum: - Agriculture / Fishing / Food Production - Building and Construction - Private Sector - Building and Construction - Public Sector - Education - Energy - generation and distribution - Health & Human Services - IT services - Manufacturing - Manufacturing - computer & electronics - Manufacturing - consumer related - Media - Other - Renewable - Retail Trading - Service Sector - F&B - Service Sector - non-F&B - Transport & Logistics - Wholesale Trader description: Industry indicates the type of activity in which company is involved. For eg. Travel, Media, Manufacuring etc example: IT services address: type: string default: '' example: 100 North St, Singapore description: "Address of company.\n - ``` /^(?:(?=^.*([0-9]|[a-z]|[A-Z]))(([0-9]|[a-z]|[A-Z]))|([0-9]|[a-z]|[A-Z]))/g\ \ ```\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" zipCode: type: string default: '' example: '155010' description: "ZipCode/PinCode for address.\n - ``` /^[A-Za-z0-9]+$/ ```\n \n Shouldn't match:\n - ```/^[\\W_]+$/```" state: type: string example: Central Region default: '' description: "State in which company is located.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" district: type: string example: Bedok default: '' description: "District in which company is located.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" city: type: string example: Downtown default: '' description: "City in which company is located.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" area: type: string example: PC garden default: '' description: "Area in which company is located.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" street: type: string example: SD School St default: '' description: "Street in which company is located.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" country: type: string default: '' example: Singapore description: "Country in which company is located.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" mobileNo: type: string default: '' example: '+6578787141' description: "Company/Customer's Mobile number along with country code.\n - ```<= 15 characters```\n - ``` /^(\\\ +\\d{1,4}[-. ]?)?(\\()?\\d{3}(\\))?[-. ]?\\d{3}[-. ]?\\d{3,4}$/```" companyDescription: type: string default: '' example: An Insurance company... description: "Some description of company\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" taxIdNumber: type: string default: '' example: '12155154' description: "Registered tax identifixation number for company\n - ``` /^[A-Za-z0-9+-]+$/ ```\n \n Shouldn't match:\n\ \ - ```/^[a-z]+$/i```\n\n - ```/^[\\W_]+$/```" bankName: type: string default: '' example: DBS Bank description: "Bank name where company account is.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" bankAccountNumber: type: number default: '' example: 7818154515215451 description: Account number of company account. bankSwiftCode: type: string example: '78948142' default: '' description: "Bank Swift code.\n - ``` /^[A-Za-z0-9]+$/ ```\n \n Shouldn't match:\n - ```/^[\\W_]+$/```" bankAccountName: type: string default: '' example: HEALTHIFY INC. description: "Bank Account Name.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" bankAddress: type: string example: 78 South Region, Singapore default: '' description: "Bank Address.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" intermediaryBankName: type: string default: '' example: DBS Bank description: "Intermediary Bank Name where company account is.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\\ W_]+$/```" intermediaryBankSWIFTCode: type: string default: '' example: '78948142' description: "Intermediary Bank Swift code.\n - ``` /^[A-Za-z0-9]+$/ ```\n \n Shouldn't match:\n - ```/^[\\W_]+$/```" wireRemittanceRouteNumber: type: string default: '' example: 074000078 description: "Wire Remittance Route Number.\n - ```<= 20 characters```\n - ``` /^\\d+$/```" achRoutingNumber: type: string default: '' example: 074000078 description: "ACH Routing Number.\n - ```<= 20 characters```\n - ``` /^\\d+$/```" files: description: Customer KYC Documents type: array items: type: string format: binary applicationId: type: string default: '' example: d8eb1219-gg24-4773-97d8-b05264621e60 description: Application Id required: - customerReferenceNo - customerName - customerEmail - companyRegistrationNo - companyRegistrationDate - incorporationCountry - industry - address - zipCode - state - district - city - area - country - mobileNo - companyDescription - taxIdNumber - files - applicationId CustomerKYC: type: object properties: applicationId: type: string default: string description: Id of the application businessId: type: string default: string description: Id of the business required: - applicationId - businessId CustomerKYCResponse: type: object properties: statusCode: type: number default: 200 description: The HTTP status code of the error data: description: Response Data from the operation allOf: - $ref: '#/components/schemas/CustomerKYC' message: type: string default: Success description: Human-readable message containing all available details about the operation success: type: boolean default: true description: A boolean indicating whether this was a success response or an error response required: - statusCode - data - message - success UpdateBusinessKycDTO: type: object properties: customerName: type: string description: "Customer or a Company's Full Name.\n - ``` /^(?:(?=^.*([0-9]|[a-z]|[A-Z]))(([0-9]|[a-z]|[A-Z]))|([0-9]|[a-z]|[A-Z]))/g\ \ ```\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" default: '' example: John Doe companyRegistrationNo: type: string default: '' example: 1111111ET description: "Registration number with which company is registered.\n - ``` /^[A-Za-z0-9/-]+$/ ```" companyRegistrationDate: type: string description: Company Registration Date is a date at which company is registered. Supported Date Formats (DD-MM-YYYY/DD MMM YYYY) example: 13-07-2023 default: '' incorporationCountry: type: string default: '' example: Singapore description: "Country of incorporation for company.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" industry: type: string default: '' enum: - Agriculture / Fishing / Food Production - Building and Construction - Private Sector - Building and Construction - Public Sector - Education - Energy - generation and distribution - Health & Human Services - IT services - Manufacturing - Manufacturing - computer & electronics - Manufacturing - consumer related - Media - Other - Renewable - Retail Trading - Service Sector - F&B - Service Sector - non-F&B - Transport & Logistics - Wholesale Trader description: Industry indicates the type of activity in which company is involved. For eg. Travel, Media, Manufacuring etc example: IT services address: type: string default: '' example: 100 North St, Singapore description: "Address of company.\n - ``` /^(?:(?=^.*([0-9]|[a-z]|[A-Z]))(([0-9]|[a-z]|[A-Z]))|([0-9]|[a-z]|[A-Z]))/g\ \ ```\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" zipCode: type: string default: '' example: '155010' description: "ZipCode/PinCode for address.\n - ``` /^[A-Za-z0-9]+$/ ```\n \n Shouldn't match:\n - ```/^[\\W_]+$/```" state: type: string example: Central Region default: '' description: "State in which company is located.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" district: type: string example: Bedok default: '' description: "District in which company is located.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" city: type: string example: Downtown default: '' description: "City in which company is located.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" area: type: string example: PC garden default: '' description: "Area in which company is located.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" street: type: string example: SD School St default: '' description: "Street in which company is located.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" country: type: string default: '' example: Singapore description: "Country in which company is located.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" mobileNo: type: string default: '' example: '+6578787141' description: "Company/Customer's Mobile number along with country code.\n - ```<= 15 characters```\n - ``` /^(\\\ +\\d{1,4}[-. ]?)?(\\()?\\d{3}(\\))?[-. ]?\\d{3}[-. ]?\\d{3,4}$/```" companyDescription: type: string default: '' example: An Insurance company... description: "Some description of company\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" taxIdNumber: type: string default: '' example: '12155154' description: "Registered tax identifixation number for company\n - ``` /^[A-Za-z0-9+-]+$/ ```\n \n Shouldn't match:\n\ \ - ```/^[a-z]+$/i```\n\n - ```/^[\\W_]+$/```" bankName: type: string default: '' example: DBS Bank description: "Bank name where company account is.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" bankAccountNumber: type: number default: '' example: 7818154515215451 description: Account number of company account. bankSwiftCode: type: string example: '78948142' default: '' description: "Bank Swift code.\n - ``` /^[A-Za-z0-9]+$/ ```\n \n Shouldn't match:\n - ```/^[\\W_]+$/```" bankAccountName: type: string default: '' example: HEALTHIFY INC. description: "Bank Account Name.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" bankAddress: type: string example: 78 South Region, Singapore default: '' description: "Bank Address.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" intermediaryBankName: type: string default: '' example: DBS Bank description: "Intermediary Bank Name where company account is.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\\ W_]+$/```" intermediaryBankSWIFTCode: type: string default: '' example: '78948142' description: "Intermediary Bank Swift code.\n - ``` /^[A-Za-z0-9]+$/ ```\n \n Shouldn't match:\n - ```/^[\\W_]+$/```" wireRemittanceRouteNumber: type: number default: '' example: 074000078 description: "Wire Remittance Route Number.\n - ```<= 20 characters```\n - ``` /^\\d+$/```" achRoutingNumber: type: number default: '' example: 074000078 description: "ACH Routing Number.\n - ```<= 20 characters```\n - ``` /^\\d+$/```" files: description: Customer KYC Documents type: array items: type: string format: binary applicationId: type: string default: '' example: d8eb1219-gg24-4773-97d8-b05264621e60 description: Application Id businessId: type: string default: '' example: d8eb1219-gg24-4773-97d8-b05264621e60 description: Business Id required: - applicationId - businessId AddDirectorKycDTO: type: object properties: directorName: type: string default: '' example: Marques Brownlee description: "Name of the director.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" personalIdentificationNumber: type: string default: '' example: B88964115515A description: "Personal identification number.\n - ``` /^[A-Za-z0-9+-]+$/ ```\n \n Shouldn't match:\n - ```/^[\\\ W_]+$/```" shareholding: type: string description: The amount of shares that director owns in a company or business example: '10' email: type: string example: m.brownlee@healthify.com default: '' description: Email address of director. address: type: string default: '' example: 45 West Region, Singpoare description: "Address of director.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" zipCode: type: string default: '' example: '79581' description: "ZipCode/PinCode for address.\n \n Shouldn't match:\n - ```/^[\\W_]+$/```" state: type: string example: Central Region default: '' description: "State of the director\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" district: type: string example: Bedok default: '' description: "District of the director\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" city: type: string example: Downtown default: '' description: "City of the director\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" area: type: string example: PC garden default: '' description: "Area of the director\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" street: type: string example: SD School St default: '' description: "Street in which director is located.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" phone: type: string default: '' example: '+6545457414' description: "Contact phone number of director.\n \n Shouldn't match:\n - ```/^[\\W_]+$/```" country: type: string default: '' example: Singapore description: "Country of director.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" files: description: Director KYC Documents type: array items: type: string format: binary status: type: string description: Director Status example: active enum: - active - inactive applicationId: type: string default: '' example: d8eb1219-gg24-4773-97d8-b05264621e60 description: Application Id businessId: type: string default: '' example: d8eb1219-gg24-4773-97d8-b05264621e60 description: Business Id required: - directorName - personalIdentificationNumber - shareholding - email - address - zipCode - state - phone - country - status - applicationId - businessId DirectorKYC: type: object properties: applicationId: type: string default: string description: Id of the application businessId: type: string default: string description: Id of the business directorId: type: string default: string description: Id of the director required: - applicationId - businessId - directorId DirectorKYCResponse: type: object properties: statusCode: type: number default: 200 description: The HTTP status code of the error data: description: Response Data from the operation allOf: - $ref: '#/components/schemas/DirectorKYC' message: type: string default: Success description: Human-readable message containing all available details about the operation success: type: boolean default: true description: A boolean indicating whether this was a success response or an error response required: - statusCode - data - message - success UpdateDirectorKycDTO: type: object properties: directorName: type: string default: '' example: Marques Brownlee description: "Name of the director.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" personalIdentificationNumber: type: string example: B88964115515A description: "Personal identification number.\n - ``` /^[A-Za-z0-9+-]+$/ ```\n \n Shouldn't match:\n - ```/^[\\\ W_]+$/```" shareholding: type: string description: The amount of shares that director owns in a company or business example: '10' email: type: string example: m.brownlee@healthify.com default: '' description: Email address of director. address: type: string default: '' example: 45 West Region, Singpoare description: "Address of director.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" zipCode: type: string default: '' example: '79581' description: "ZipCode/PinCode for address.\n \n Shouldn't match:\n - ```/^[\\W_]+$/```" state: type: string example: Central Region default: '' description: "State of the director\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" district: type: string example: Bedok default: '' description: "District of the director\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" city: type: string example: Downtown default: '' description: "City of the director\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" area: type: string example: PC garden default: '' description: "Area of the director\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" street: type: string example: SD School St default: '' description: "Street in which director is located\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" phone: type: string default: '' example: '+6545457414' description: "Contact phone number of director.\n \n Shouldn't match:\n - ```/^[\\W_]+$/```" country: type: string default: '' example: Singapore description: "Country of director.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" files: description: Director KYC Documents type: array items: type: string format: binary status: type: string description: Director Status example: active enum: - active - inactive applicationId: type: string default: '' example: d8eb1219-gg24-4773-97d8-b05264621e60 description: Application Id businessId: type: string default: '' example: d8eb1219-gg24-4773-97d8-b05264621e60 description: Business Id directorId: type: string default: '' example: d8eb1219-gg24-4773-97d8-b05264621e60 description: Director Id required: - applicationId - businessId - directorId SendForKycReviewDto: type: object properties: applicationId: type: string default: '' example: d8eb1219-gg24-4773-97d8-b05264621e60 description: Application Id kycType: type: string default: business example: individual description: individual | business required: - applicationId KycDetails: type: object properties: applicationId: type: string default: string description: Id of the application required: - applicationId KycApprovalSubmitResponse: type: object properties: statusCode: type: number default: 200 description: The HTTP status code of the error data: description: Response Data from the operation allOf: - $ref: '#/components/schemas/KycDetails' message: type: string default: Success description: Human-readable message containing all available details about the operation success: type: boolean default: true description: A boolean indicating whether this was a success response or an error response required: - statusCode - data - message - success KycDetailsDocumentsResponse: type: object properties: createdAt: type: string default: '2025-01-08T05:12:18.005Z' description: Created Timestamp of the payment in UTC Format eg. 2023-03-30T11:46:42.195Z updatedAt: type: string default: '2025-01-08T05:12:18.005Z' description: Updated Timestamp of the payment in UTC Format eg. 2023-03-30T11:46:42.195Z documentId: type: string default: string description: Id of the document fileName: type: string default: string description: Name of the document. type: type: string default: string description: Type of document Eg:(Passport or Utility Bill etc.) required: - createdAt - updatedAt - documentId - fileName - type KycDetailsDirectorResponse: type: object properties: directorId: type: string default: string description: Id of the director status: type: string description: Director Status example: active enum: - active - inactive directorName: type: string default: string description: Name of the director. email: type: string default: string description: Email address of director. mobileNo: type: string default: string description: Contact phone number of director. shareholding: type: string default: string description: The amount of shares that director owns in a company or business personalIdentificationNumber: type: string default: string description: Personal identification number. address: type: string default: string description: Address of director. country: type: string default: string description: Country of director. zipCode: type: string default: string description: ZipCode/PinCode for address. state: type: string default: string description: State of the director district: type: string default: string description: District of the director city: type: string default: string description: City of the director area: type: string default: string description: Area of the director street: type: string default: string description: Street of the director documents: $ref: '#/components/schemas/KycDetailsDocumentsResponse' required: - directorId - directorName - email - mobileNo - shareholding - personalIdentificationNumber - address - country - zipCode - state - district - city - area - street - documents KycDetailsBusinessResponse: type: object properties: createdAt: type: string default: '2025-01-08T05:12:18.005Z' description: Created Timestamp of the payment in UTC Format eg. 2023-03-30T11:46:42.195Z updatedAt: type: string default: '2025-01-08T05:12:18.005Z' description: Updated Timestamp of the payment in UTC Format eg. 2023-03-30T11:46:42.195Z businessId: type: string default: string description: Id of the business customerReferenceNo: type: string default: string description: Customer reference number customerName: type: string default: string description: Customer or a Company's Full Name. customerEmail: type: string default: string description: Email address of Customer/company which is used for login to B2B PayLater portal. mobileNo: type: string default: string description: Company/Customer's Mobile number along with country code. taxIdentificationNo: type: string default: string description: Registered tax identifixation number for company companyRegistrationNo: type: string default: string description: Registration number with which company is registered. companyRegistrationDate: type: string default: string description: Company Registration Date is a date at which company is registered. companyDescription: type: string default: string description: Some description of company incorporationCountry: type: string default: string description: Country of incorporation for company. industry: type: string default: string description: Industry indicates the type of activity in which company is involved. For eg. Travel, Media, Manufacuring etc country: type: string default: string description: Country in which company is located. zipCode: type: string default: string description: ZipCode/PinCode for address. state: type: string default: string description: State in which company is located. district: type: string default: string description: District in which company is located. city: type: string default: string description: City in which company is located. area: type: string default: string description: Area in which company is located. street: type: string default: string description: Street in which company is located. bankName: type: string default: string description: Bank name where company account is. bankAccountNumber: type: string default: string description: Account number of company account. bankAccountName: type: string default: string description: Bank Account Name. bankSwiftCode: type: string default: string description: Bank Swift code. bankAddress: type: string default: string description: Bank Address. documents: type: array items: $ref: '#/components/schemas/KycDetailsDocumentsResponse' directors: type: array items: $ref: '#/components/schemas/KycDetailsDirectorResponse' required: - createdAt - updatedAt - businessId - customerReferenceNo - customerName - customerEmail - mobileNo - taxIdentificationNo - companyRegistrationNo - companyRegistrationDate - companyDescription - incorporationCountry - industry - country - zipCode - state - district - city - area - street - bankName - bankAccountNumber - bankAccountName - bankSwiftCode - bankAddress - documents - directors KycDetailsAggResponse: type: object properties: applicationId: type: string default: string description: Id of the application dataConsent: type: boolean default: true description: Data Consent business: type: array items: $ref: '#/components/schemas/KycDetailsBusinessResponse' required: - applicationId - dataConsent - business KYCDetailsResponse: type: object properties: statusCode: type: number default: 200 description: The HTTP status code of the error data: description: Response Data from the operation allOf: - $ref: '#/components/schemas/KycDetailsAggResponse' message: type: string default: Success description: Human-readable message containing all available details about the operation success: type: boolean default: true description: A boolean indicating whether this was a success response or an error response required: - statusCode - data - message - success AddIndividualKycDTO: type: object properties: customerReferenceNo: type: string default: '' example: c3eb1619-ff24-4773-97d8-b05264621e60 description: Customer reference number businessName: type: string description: "Business Name\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" default: '' country: type: string default: '' example: Singapore description: "Country in which company is located.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" industry: type: string default: '' enum: - Agriculture / Fishing / Food Production - Building and Construction - Private Sector - Building and Construction - Public Sector - Education - Energy - generation and distribution - Health & Human Services - IT services - Manufacturing - Manufacturing - computer & electronics - Manufacturing - consumer related - Media - Other - Renewable - Retail Trading - Service Sector - F&B - Service Sector - non-F&B - Transport & Logistics - Wholesale Trader description: Industry indicates the type of activity in which company is involved. For eg. Travel, Media, Manufacuring etc example: IT services businessAddress: type: string default: '' example: 100 North St, Singapore description: "Address\n - ``` /^(?:(?=^.*([0-9]|[a-z]|[A-Z]))(([0-9]|[a-z]|[A-Z]))|([0-9]|[a-z]|[A-Z]))/g ```\n\ \ \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" businessArea: type: string example: PC garden default: '' description: "Area in which company is located.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" businessStreet: type: string example: SD School St default: '' description: "Street in which company is located.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" businessZipCode: type: string default: '' example: '155010' description: "ZipCode/PinCode for address.\n - ``` /^[A-Za-z0-9]+$/ ```\n \n Shouldn't match:\n - ```/^[\\W_]+$/```" businessState: type: string example: Central Region default: '' description: "State in which company is located.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" businessDistrict: type: string example: Bedok default: '' description: "District in which company is located.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" businessCity: type: string example: Downtown default: '' description: "City in which company is located.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" businessDescription: type: string default: '' example: An Insurance company... description: "Some description of company\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" businessMobileNumber: type: string default: '' example: '+6578787141' description: "Company/Customer's Mobile number along with country code.\n - ```<= 15 characters```\n - ``` /^(\\\ +\\d{1,4}[-. ]?)?(\\()?\\d{3}(\\))?[-. ]?\\d{3}[-. ]?\\d{3,4}$/```" bankName: type: string default: '' example: DBS Bank description: "Bank name where company account is.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" bankAccountNumber: type: number default: '' example: 7818154515215451 description: Account number of company account. bankSwiftCode: type: string example: '78948142' default: '' description: "Bank Swift code.\n - ``` /^[A-Za-z0-9]+$/ ```\n \n Shouldn't match:\n - ```/^[\\W_]+$/```" bankAccountName: type: string default: '' example: HEALTHIFY INC. description: "Bank Account Name.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" bankAddress: type: string example: 78 South Region, Singapore default: '' description: "Bank Address.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" intermediaryBankName: type: string default: '' example: DBS Bank description: "Intermediary Bank Name where company account is.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\\ W_]+$/```" intermediaryBankSWIFTCode: type: string default: '' example: '78948142' description: "Intermediary Bank Swift code.\n - ``` /^[A-Za-z0-9]+$/ ```\n \n Shouldn't match:\n - ```/^[\\W_]+$/```" wireRemittanceRouteNumber: type: string default: '' example: 074000078 description: "Wire Remittance Route Number.\n - ```<= 20 characters```\n - ``` /^\\d+$/```" achRoutingNumber: type: string default: '' example: 074000078 description: "ACH Routing Number.\n - ```<= 20 characters```\n - ``` /^\\d+$/```" fullName: type: string default: '' example: Marques Brownlee description: "Name of the owner.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" email: type: string example: m.brownlee@healthify.com default: '' description: Email address of owner. personalIdentificationNumber: type: string default: '' example: B88964115515A description: "Personal identification number.\n - ``` /^[A-Za-z0-9+-]+$/ ```\n \n Shouldn't match:\n - ```/^[\\\ W_]+$/```" ownerStatus: type: string description: Owner Status example: active enum: - active - inactive ownersResidentialAddress: type: string default: '' example: 45 West Region, Singpoare description: "Address of Owner.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" ownerArea: type: string example: PC garden default: '' description: "Area of the owner\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" ownerStreet: type: string example: SD School St default: '' description: "Street in which owner is located.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" ownerZipCode: type: string default: '' example: '79581' description: "ZipCode/PinCode for address.\n \n Shouldn't match:\n - ```/^[\\W_]+$/```" ownerState: type: string example: Central Region default: '' description: "State of the owner\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" ownerDistrict: type: string example: Bedok default: '' description: "District of the owner\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" ownerCity: type: string example: Downtown default: '' description: "City of the owner\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" ownerMobileNumber: type: string default: '' example: '+6578787141' description: "Owner's Mobile number along with country code.\n - ```<= 15 characters```\n - ``` /^(\\+\\d{1,4}[-.\ \ ]?)?(\\()?\\d{3}(\\))?[-. ]?\\d{3}[-. ]?\\d{3,4}$/```" files: description: KYC Documents type: array items: type: string format: binary applicationId: type: string default: '' example: d8eb1219-gg24-4773-97d8-b05264621e60 description: Application Id required: - customerReferenceNo - businessName - country - industry - businessAddress - businessArea - businessStreet - businessZipCode - businessState - businessDistrict - businessCity - businessDescription - fullName - email - personalIdentificationNumber - ownerStatus - ownersResidentialAddress - ownerArea - ownerStreet - ownerZipCode - ownerState - ownerMobileNumber - files - applicationId IndividualKYC: type: object properties: applicationId: type: string default: string description: Id of the application businessId: type: string default: string description: Id of the business directorId: type: string default: string description: Id of the director required: - applicationId - businessId - directorId IndividualCustomerKYCResponse: type: object properties: statusCode: type: number default: 200 description: The HTTP status code of the error data: description: Response Data from the operation allOf: - $ref: '#/components/schemas/IndividualKYC' message: type: string default: Success description: Human-readable message containing all available details about the operation success: type: boolean default: true description: A boolean indicating whether this was a success response or an error response required: - statusCode - data - message - success UpdateIndividualKycDTO: type: object properties: customerReferenceNo: type: string default: '' example: c3eb1619-ff24-4773-97d8-b05264621e60 description: Customer reference number businessName: type: string description: "Business Name\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" default: '' industry: type: string default: '' enum: - Agriculture / Fishing / Food Production - Building and Construction - Private Sector - Building and Construction - Public Sector - Education - Energy - generation and distribution - Health & Human Services - IT services - Manufacturing - Manufacturing - computer & electronics - Manufacturing - consumer related - Media - Other - Renewable - Retail Trading - Service Sector - F&B - Service Sector - non-F&B - Transport & Logistics - Wholesale Trader description: Industry indicates the type of activity in which company is involved. For eg. Travel, Media, Manufacuring etc example: IT services businessAddress: type: string default: '' example: 45 West Region, Singpoare description: "Address of business. This could be same address as owner address\n \n Shouldn't match:\n - ```/^\\\ d+$/```\n\n - ```/^[\\W_]+$/```" businessArea: type: string example: PC garden default: '' description: "Area of the business\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" businessStreet: type: string example: SD School St default: '' description: "Street in which company is located.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" businessZipCode: type: string default: '' example: '79581' description: "ZipCode/PinCode for address.\n \n Shouldn't match:\n - ```/^[\\W_]+$/```" businessState: type: string example: Central Region default: '' description: "State of the business\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" businessDistrict: type: string example: Bedok default: '' description: "District of the business\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" businessCity: type: string example: Downtown default: '' description: "City of the business\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" businessDescription: type: string default: '' example: An Insurance company... description: "Some description of company\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" businessMobileNumber: type: string default: '' example: '+6578787141' description: "Company/Customer's Mobile number along with country code.\n - ```<= 15 characters```\n - ``` /^(\\\ +\\d{1,4}[-. ]?)?(\\()?\\d{3}(\\))?[-. ]?\\d{3}[-. ]?\\d{3,4}$/```" bankName: type: string default: '' example: DBS Bank description: "Bank name where company account is.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" bankAccountNumber: type: number default: '' example: 7818154515215451 description: Account number of company account. bankSwiftCode: type: string example: '78948142' default: '' description: "Bank Swift code.\n - ``` /^[A-Za-z0-9]+$/ ```\n \n Shouldn't match:\n - ```/^[\\W_]+$/```" bankAccountName: type: string default: '' example: HEALTHIFY INC. description: "Bank Account Name.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" bankAddress: type: string example: 78 South Region, Singapore default: '' description: "Bank Address.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" intermediaryBankName: type: string default: '' example: DBS Bank description: "Intermediary Bank Name where company account is.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\\ W_]+$/```" intermediaryBankSWIFTCode: type: string default: '' example: '78948142' description: "Intermediary Bank Swift code.\n - ``` /^[A-Za-z0-9]+$/ ```\n \n Shouldn't match:\n - ```/^[\\W_]+$/```" wireRemittanceRouteNumber: type: number default: '' example: 074000078 description: "Wire Remittance Route Number.\n - ```<= 20 characters```\n - ``` /^\\d+$/```" achRoutingNumber: type: number default: '' example: 074000078 description: "ACH Routing Number.\n - ```<= 20 characters```\n - ``` /^\\d+$/```" fullName: type: string default: '' example: Marques Brownlee description: "Name of the owner.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" email: type: string example: m.brownlee@healthify.com default: '' description: Email address of owner. numberOfShareholding: type: string description: The amount of shares that owner owns in a company or business example: '10' ownerStatus: type: string description: Owner Status example: active enum: - active - inactive personalIdentificationNumber: type: string example: B88964115515A description: "Personal identification number.\n - ``` /^[A-Za-z0-9+-]+$/ ```\n \n Shouldn't match:\n - ```/^[\\\ W_]+$/```" ownersResidentialAddress: type: string default: '' example: 45 West Region, Singpoare description: "Address of owner.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" ownerArea: type: string example: PC garden default: '' description: "Area of the owner\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" ownerStreet: type: string example: SD School St default: '' description: "Street in which owner is located.\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" ownerZipCode: type: string default: '' example: '79581' description: "ZipCode/PinCode for address.\n \n Shouldn't match:\n - ```/^[\\W_]+$/```" ownerState: type: string example: Central Region default: '' description: "State of the owner\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" ownerDistrict: type: string example: Bedok default: '' description: "District of the owner\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" ownerCity: type: string example: Downtown default: '' description: "City of the owner\n \n Shouldn't match:\n - ```/^\\d+$/```\n\n - ```/^[\\W_]+$/```" ownerMobileNumber: type: string default: '' example: '+6578787141' description: "Owner's Mobile number along with country code.\n - ```<= 15 characters```\n - ``` /^(\\+\\d{1,4}[-.\ \ ]?)?(\\()?\\d{3}(\\))?[-. ]?\\d{3}[-. ]?\\d{3,4}$/```" files: description: KYC Documents type: array items: type: string format: binary applicationId: type: string default: '' example: d8eb1219-gg24-4773-97d8-b05264621e60 description: Application Id businessId: type: string default: '' example: d8eb1219-gg24-4773-97d8-b05264621e60 description: Business Id directorId: type: string default: '' example: d8eb1219-gg24-4773-97d8-b05264621e60 description: Director Id required: - applicationId - businessId - directorId BankTransferType: type: object properties: bankName: type: string default: '' description: Deutche Bank accountNumber: type: number description: For Eg. 1177441144 default: 0 bankSwiftCode: type: string description: IC114744 default: '' accountName: type: string description: John Doe default: '' required: - bankName - accountNumber - bankSwiftCode - accountName PaymentMethodsResponse: type: object properties: bankTransfer: description: Bank Transfer Payment Method allOf: - $ref: '#/components/schemas/BankTransferType' uenPayment: description: UEN Payment Method allOf: - $ref: '#/components/schemas/BankTransferType' qrPayment: type: string description: QR Payment Method required: - bankTransfer - uenPayment - qrPayment CustomerChosenPaymentsResponse: type: object properties: statusCode: type: number default: 200 description: The HTTP status code of the error data: description: Response Data from the operation type: array items: $ref: '#/components/schemas/PaymentMethodsResponse' message: type: string default: Success description: Human-readable message containing all available details about the operation success: type: boolean default: true description: A boolean indicating whether this was a success response or an error response required: - statusCode - data - message - success CustomerNotFoundResponse: type: object properties: statusCode: type: number default: 404 description: The HTTP status code of the error error: type: string default: string description: Human-readable generic error message errorCode: type: string default: E_C_CUSTOMER_NOT_FOUND description: Computer-readable code for error handling message: type: string default: string description: Human-readable error message containing all available details about how the error occurred success: type: boolean default: false description: A boolean indicating whether this was a success response or an error response required: - statusCode - error - errorCode - message - success CustomerCreditLine: type: object properties: customerReferenceNo: type: string default: string description: Customer Reference Number availableCredit: type: number default: 10000 description: Customer's available credit limit approvedCredit: type: number default: 15000 description: Customer's approved credit limit totalOutstandingAmount: type: number default: 1500000 description: Total payable outstanding amount by customer totalUtilised: type: number default: 10000 description: Total utilised credit by customer totalChargesApplied: type: number default: 500 description: Total charges applied on loans totalLoanAmount: type: number default: 500 description: Total loan amount excluding charges currency: type: string default: SGD description: Currency Code required: - customerReferenceNo - availableCredit - approvedCredit - totalOutstandingAmount - totalUtilised - totalChargesApplied - totalLoanAmount - currency CreditLineResponse: type: object properties: statusCode: type: number default: 200 description: The HTTP status code of the error data: description: Response Data from the operation allOf: - $ref: '#/components/schemas/CustomerCreditLine' message: type: string default: Success description: Human-readable message containing all available details about the operation success: type: boolean default: true description: A boolean indicating whether this was a success response or an error response required: - statusCode - data - message - success RepaymentScheduleV2Response: type: object properties: dueDate: type: string description: Loan Due Date eg. 18 September 2023 default: 18 September 2023 example: 18 September 2023 totalDueForPeriod: type: number description: Total due payment for current period example: 3599.17 penaltyDueForPeriod: type: number description: Total due penalty for current period example: 0 totalServiceFeeForPeriod: type: number description: Total Service fee for current period example: 99.17 totalServiceFeeDueForPeriod: type: number description: Total Service fee due for current period example: 99.17 principalDueForPeriod: type: number description: Total due principal for current period example: 3500 dueDatePostGracePeriod: type: string description: Due date with grace period eg. 21 September 2023 example: 21 September 2023 paid: type: boolean description: indicates that payment is completed or not example: false required: - dueDate - totalDueForPeriod - penaltyDueForPeriod - totalServiceFeeForPeriod - totalServiceFeeDueForPeriod - principalDueForPeriod - dueDatePostGracePeriod - paid LoanPayment: type: object properties: paymentId: type: string default: string description: Id of the payment paymentDate: type: string default: '2025-01-08T05:12:17.404Z' description: Date of the payment in UTC Format eg. 2023-03-30T11:46:42.195Z paymentAmount: type: number default: 1000 description: Payment Amount paymentMethod: type: string default: 1000 description: Payment Amount example: Bank Transfer/UEN Payment/QR Code Payment paymentReferenceNo: type: string default: string description: Payment reference number provided while making payment accountNumber: type: string default: string description: "Account Number varies based on payment types.\n \n\nSo for bank transfer payment( this field\ \ will contain ```bank account number``` & for UEN number payment this will contain ```UEN Number```" accountName: type: string default: string description: Account Name to which payment has been made. bankName: type: string default: string description: "Bank Name varies based on payment types.\n \n\nSo for bank transfer payment this field will be\ \ present, for rest of the types it will be empty" bankSwiftCode: type: string default: string description: "Bank Swift Code varies based on payment types.\n \n\nSo for bank transfer payment this field\ \ will be present, for rest of the types it will be empty" paymentStatus: type: number default: 2 description: "We have 3 types of payment status codes. \n \n For payment rejected: ```0``` \n \n For payment\ \ done, but verification pending: ```1```\n \n For payment done & verified: ```2```" loanId: type: string default: string description: Loan Id, for which payment has been made. customerReferenceNo: type: string default: string description: Customer Reference Number, for which payment has been made. metadata: type: string default: string description: Metadata for payments. It can be used for reporting, reconciliation purpose. createdAt: type: string default: '2025-01-08T05:12:17.405Z' description: Created Timestamp of the payment in UTC Format eg. 2023-03-30T11:46:42.195Z updatedAt: type: string default: '2025-01-08T05:12:17.405Z' description: Updated Timestamp of the payment in UTC Format eg. 2023-03-30T11:46:42.195Z currency: type: string default: SGD description: Currency Code required: - paymentId - paymentDate - paymentAmount - paymentMethod - paymentReferenceNo - accountNumber - accountName - bankName - bankSwiftCode - paymentStatus - loanId - customerReferenceNo - metadata - createdAt - updatedAt - currency LoanSummaryResponse: type: object properties: loanId: type: string default: string description: Id of the created loan loanStatus: type: string description: "Status of loan\n \n We support these three statuses,\n \n 1. ```pending-for-approval``` - Loan\ \ is pending for approval\n \n 2. ```waiting-for-disbursal``` - Loan is pending for disbursal,\n \n 3. ```active```\ \ - Loan is active,\n \n 4. ```rejected``` - Loan is rejected for some reason,\n \n 5. ```closed``` - Loan\ \ is paid & closed" example: active loanReferenceNo: type: string default: BNPL180820235070 description: Loan Reference number loanType: type: string description: "Type of loan\n \n We support these 4 types,\n \n 1. ```BNPL``` - Buyer Financing\n \n 2.\ \ ```BNPL_Term``` - Buyer Financing Term Loan\n \n 3. ```GMV``` - Seller Financing\n \n 4. ```GMV_Term```\ \ - Seller Financing Term Loan" example: BNPL customerReferenceNo: type: string default: '' description: Customer Reference number, for which loan is created loanTerm: type: number example: 30 description: Duration of the loan. Based on loan terms selected at the cusomer level, The customer for whom loan is being created should be enum: - 30 - 45 - 60 - 90 - 120 - 150 - 180 - 210 - 240 - 270 - 300 - 330 - 360 default: 30 loanAmount: type: number description: Loan Amount example: 3500 totalServiceFee: type: number description: Total Service fee applied on loan example: 99.17 totalServiceFeeDue: type: number description: Total Service fee Due for loan example: 99.17 expectedRepaymentAmount: type: number description: Total Expected Repayment Amount default: 3599.17 totalDueAmount: type: number description: Total Due amount that is remaining to repay default: 3599.17 loanDueDate: type: string description: Loan Due Date eg. 18 September 2023 default: 18 September 2023 example: 18 September 2023 dueDatePostGracePeriod: type: string description: Due date with Grace Period, eg. Loan Due date is 18 September 2023, and grace period is 3 days. so dueDatePostGracePeriod will be 21 September 2023 default: 18 September 2023 example: 21 September 2023 gracePeriodInDays: type: number description: Grace Period(In Days), After which loan goes into overdue. default: 3 example: 3 totalPenaltyDue: type: number description: Penalty outstanding that needs to repay default: 0 example: 0 currency: type: string default: SGD description: Currency Code requestedDate: type: string description: Loan Due Date eg. 18 Aug 2023 default: 18 Aug 2023 example: 18 Aug 2023 repaymentSchedule: description: Repayment schedule for loan type: array items: $ref: '#/components/schemas/RepaymentScheduleV2Response' payments: description: All payments done by customer for the loan type: array items: $ref: '#/components/schemas/LoanPayment' required: - loanId - loanStatus - loanReferenceNo - loanType - customerReferenceNo - loanTerm - loanAmount - totalServiceFee - totalServiceFeeDue - expectedRepaymentAmount - totalDueAmount - loanDueDate - dueDatePostGracePeriod - gracePeriodInDays - totalPenaltyDue - currency - requestedDate - repaymentSchedule - payments CustomerActiveLoansResponse: type: object properties: statusCode: type: number default: 200 description: The HTTP status code of the error data: description: Response Data from the operation type: array items: $ref: '#/components/schemas/LoanSummaryResponse' message: type: string default: Success description: Human-readable message containing all available details about the operation success: type: boolean default: true description: A boolean indicating whether this was a success response or an error response required: - statusCode - data - message - success HolidayResponse: type: object properties: date: type: string description: Date String example: 01 Jan 2024 dateUTC: type: string description: Date ISO String example: '2023-12-31T18:30:00.000Z' isHoliday: type: boolean description: Date is holiday or not example: true required: - date - dateUTC - isHoliday HolidayListResponse: type: object properties: statusCode: type: number default: 200 description: The HTTP status code of the error data: description: Response Data from the operation type: array items: $ref: '#/components/schemas/HolidayResponse' message: type: string default: Success description: Human-readable message containing all available details about the operation success: type: boolean default: true description: A boolean indicating whether this was a success response or an error response required: - statusCode - data - message - success CalculateLoanScheduleV1Dto: type: object properties: customerReferenceNo: type: string default: '' example: c3eb1619-ff24-4773-97d8-b05264621e60 description: "Customer Reference number. Each customer has unique reference number. Enter reference number of the\ \ customer for whom loan should be created.\n - ``` /^S*$/ ```" loanAmount: type: number description: "Loan Amount.\n \n - Support decimal values as well." example: 50000 loanTerm: type: number example: 30 description: Duration of the loan. Based on loan terms selected at the cusomer level, The customer for whom loan is being created should be. enum: - 30 - 45 - 60 - 90 - 120 - 150 - 180 - 210 - 240 - 270 - 300 - 330 - 360 default: 30 loanType: type: string description: "\nType of loan.\n \n We support these two types,\n \n 1. ```BNPL``` - Buyer Financing\n \n\ \ 2. ```GMV``` - Seller Financing" enum: - BNPL - GMV - BNPL_Term - GMV_Term example: BNPL required: - customerReferenceNo - loanAmount - loanTerm - loanType CalculateLoanResponse: type: object properties: customerReferenceNo: type: string default: '' description: Customer Reference number, for which loan is created loanTerm: type: number example: 30 description: Duration of the loan. Based on loan terms selected at the cusomer level, The customer for whom loan is being created should be enum: - 30 - 45 - 60 - 90 - 120 - 150 - 180 - 210 - 240 - 270 - 300 - 330 - 360 default: 30 totalDueAmount: type: number description: Total Loan Due Amount default: 2000 loanDueDate: type: string description: Total Loan Due Amount in UTC Format eg. 2023-03-30T11:46:42.195Z default: '2025-01-08T05:12:17.406Z' disbursalAmount: type: number description: Loan Amount default: 2000 chargesApplied: type: number description: Total Amount of Charges Applied on Loan Amount default: 50 totalRepaymentExpected: type: number description: Total Repayment Expected default: 2000 currency: type: string description: Currency Code default: SGD required: - customerReferenceNo - loanTerm - totalDueAmount - loanDueDate - disbursalAmount - chargesApplied - totalRepaymentExpected - currency GetCalculateLoanResponse: type: object properties: statusCode: type: number default: 200 description: The HTTP status code of the error data: description: Response Data from the operation allOf: - $ref: '#/components/schemas/CalculateLoanResponse' message: type: string default: Success description: Human-readable message containing all available details about the operation success: type: boolean default: true description: A boolean indicating whether this was a success response or an error response required: - statusCode - data - message - success BadRequestDrawdownResponse: type: object properties: statusCode: type: number default: 400 error: default: '' oneOf: - type: string - type: array items: type: string errorCode: default: '' oneOf: - type: string - type: array items: type: string message: default: Error oneOf: - type: string - type: array items: type: string success: type: boolean default: false required: - statusCode - error - errorCode - message - success CreateLoanV1Dto: type: object properties: customerReferenceNo: type: string default: '' example: c3eb1619-ff24-4773-97d8-b05264621e60 description: "Customer Reference number. Each customer has unique reference number. Enter reference number of the\ \ customer for whom loan should be created.\n - ``` /^S*$/ ```" loanAmount: type: number description: "Loan Amount.\n \n - Support decimal values as well." example: 50000 loanType: type: string description: "\nType of loan.\n \n We support these two types,\n \n 1. ```BNPL``` - Buyer Financing\n \n\ \ 2. ```GMV``` - Seller Financing" enum: - BNPL - GMV - BNPL_Term - GMV_Term example: BNPL loanTerm: type: number example: 30 description: Duration of the loan. Based on loan terms selected at the cusomer level, The customer for whom loan is being created should be. enum: - 30 - 45 - 60 - 90 - 120 - 150 - 180 - 210 - 240 - 270 - 300 - 330 - 360 default: 30 remark: type: string description: Comments if any. example: Loan for xyz ltd, construction purpose metadata: type: string description: Metadata for loans. It can be used for reporting, reconciliation purpose. example: '' preApproved: type: boolean description: Flag to create pre-approved loan, Default value will be true. example: true required: - customerReferenceNo - loanAmount - loanType - loanTerm LoanResponse: type: object properties: loanId: type: string default: string description: Id of the created loan loanReferenceNo: type: string default: string description: Reference Number of the created loan for eg. BNPL*** customerReferenceNo: type: string default: '' description: Customer Reference number, for which loan is created loanTerm: type: number example: 30 description: Duration of the loan. Based on loan terms selected at the cusomer level, The customer for whom loan is being created should be enum: - 30 - 45 - 60 - 90 - 120 - 150 - 180 - 210 - 240 - 270 - 300 - 330 - 360 default: 30 loanType: type: string description: "Type of loan\n \n We support these two types,\n \n 1. ```BNPL``` - Buyer Financing\n \n 2.\ \ ```GMV``` - Seller Financing" example: BNPL loanStatus: type: string description: "Status of loan\n \n We support these three statuses,\n \n 1. ```pending-for-approval``` - Loan\ \ is pending for approval\n \n 2. ```waiting-for-disbursal``` - Loan is pending for disbursal,\n \n 3. ```active```\ \ - Loan is active,\n \n 4. ```rejected``` - Loan is rejected for some reason,\n \n 5. ```closed``` - Loan\ \ is paid & closed" example: waiting-for-disbursal disbursalAmount: type: number description: Loan Amount default: 2000 totalDueAmount: type: number description: Total Loan Due Amount default: 2000 loanDueDate: type: string description: Loan Due Date in Local Format eg. 21 Aug 2023 default: 21 August 2023 example: 21 August 2023 loanDueDateUTC: type: string description: Loan Due Date in UTC Format eg. 2023-08-20T18:30:00.000Z default: '2023-08-20T18:30:00.000Z' example: '2023-08-20T18:30:00.000Z' dueDatePostGracePeriod: type: string description: Loan Due Date with grace period in Local Format eg. 24 Aug 2023 default: 24 August 2023 example: 24 August 2023 dueDatePostGracePeriodUTC: type: string description: Loan Due Date with grace period in UTC Format eg. 2023-08-23T18:30:00.000Z default: '2023-08-23T18:30:00.000Z' example: '2023-08-23T18:30:00.000Z' gracePeriodInDays: type: number description: Grace Period(In Days), After which loan goes into overdue. default: 3 example: 3 charges: type: number description: Total Monthly Charges(%) Applied on Loan Amount default: 1 chargesApplied: type: number description: Total Amount of Charges Applied on Loan Amount default: 50 customerApprovedCredit: type: number description: Customer Approved Credit Line default: 20000 customerAvailableCredit: type: number description: Customer Remaining Credit Line after loan default: 17500 remark: type: string description: Remark given while requesting for loan default: string metadata: type: string default: string description: Metadata for loans. It can be used for reporting, reconciliation purpose. createdAt: type: string default: '2025-01-08T05:12:17.405Z' description: Created Timestamp of the created loan in UTC Format eg. 2023-03-30T11:46:42.195Z updatedAt: type: string default: '2025-01-08T05:12:17.405Z' description: Updated Timestamp of the created loan in UTC Format eg. 2023-03-30T11:46:42.195Z currency: type: string default: SGD description: Currency Code required: - loanId - loanReferenceNo - customerReferenceNo - loanTerm - loanType - loanStatus - disbursalAmount - totalDueAmount - loanDueDate - loanDueDateUTC - dueDatePostGracePeriod - dueDatePostGracePeriodUTC - gracePeriodInDays - charges - chargesApplied - customerApprovedCredit - customerAvailableCredit - remark - metadata - createdAt - updatedAt - currency CreateDrawdownResponse: type: object properties: statusCode: type: number default: 201 description: The HTTP status code of the error data: description: Response Data from the operation allOf: - $ref: '#/components/schemas/LoanResponse' message: type: string default: Success description: Human-readable message containing all available details about the operation success: type: boolean default: true description: A boolean indicating whether this was a success response or an error response required: - statusCode - data - message - success DisburseLoanDto: type: object properties: loanId: type: string default: '' example: c3eb1619-ff24-4773-97d8-b05264621e60 description: Loan Id metadata: type: string description: Metadata for loans. It can be used for reporting, reconciliation purpose. example: '' required: - loanId DisburseLoanStatusResponse: type: object properties: loanId: type: string default: string description: Id of the created loan loanReferenceNo: type: string default: string description: Reference Number of the created loan for eg. BNPL*** customerReferenceNo: type: string default: '' description: Customer Reference number, for which loan is created loanTerm: type: number example: 30 description: Duration of the loan. Based on loan terms selected at the cusomer level, The customer for whom loan is being created should be enum: - 30 - 45 - 60 - 90 - 120 - 150 - 180 - 210 - 240 - 270 - 300 - 330 - 360 default: 30 loanType: type: string description: "Type of loan\n \n We support these two types,\n \n 1. ```BNPL``` - Buyer Financing\n \n 2.\ \ ```GMV``` - Seller Financing" example: BNPL loanStatus: type: string description: "Status of loan\n \n We support these three statuses,\n \n 1. ```pending-for-approval``` - Loan\ \ is pending for approval\n \n 2. ```waiting-for-disbursal``` - Loan is pending for disbursal,\n \n 3. ```active```\ \ - Loan is active,\n \n 4. ```rejected``` - Loan is rejected for some reason,\n \n 5. ```closed``` - Loan\ \ is paid & closed" example: active disbursalAmount: type: number description: Loan Amount default: 2000 totalDueAmount: type: number description: Total Loan Due Amount default: 2000 loanDueDate: type: string description: Loan Due Date in Local Format eg. 21 Aug 2023 default: 21 August 2023 example: 21 August 2023 loanDueDateUTC: type: string description: Loan Due Date in UTC Format eg. 2023-08-20T18:30:00.000Z default: '2023-08-20T18:30:00.000Z' example: '2023-08-20T18:30:00.000Z' dueDatePostGracePeriod: type: string description: Loan Due Date with grace period in Local Format eg. 24 Aug 2023 default: 24 August 2023 example: 24 August 2023 dueDatePostGracePeriodUTC: type: string description: Loan Due Date with grace period in UTC Format eg. 2023-08-23T18:30:00.000Z default: '2023-08-23T18:30:00.000Z' example: '2023-08-23T18:30:00.000Z' gracePeriodInDays: type: number description: Grace Period(In Days), After which loan goes into overdue. default: 3 example: 3 charges: type: number description: Total Monthly Charges(%) Applied on Loan Amount default: 1 chargesApplied: type: number description: Total Amount of Charges Applied on Loan Amount default: 50 customerApprovedCredit: type: number description: Customer Approved Credit Line default: 20000 customerAvailableCredit: type: number description: Customer Remaining Credit Line after loan default: 17500 remark: type: string description: Remark given while requesting for loan default: string metadata: type: string default: string description: Metadata for loans. It can be used for reporting, reconciliation purpose. createdAt: type: string default: '2025-01-08T05:12:17.405Z' description: Created Timestamp of the created loan in UTC Format eg. 2023-03-30T11:46:42.195Z updatedAt: type: string default: '2025-01-08T05:12:17.405Z' description: Updated Timestamp of the created loan in UTC Format eg. 2023-03-30T11:46:42.195Z currency: type: string default: SGD description: Currency Code required: - loanId - loanReferenceNo - customerReferenceNo - loanTerm - loanType - loanStatus - disbursalAmount - totalDueAmount - loanDueDate - loanDueDateUTC - dueDatePostGracePeriod - dueDatePostGracePeriodUTC - gracePeriodInDays - charges - chargesApplied - customerApprovedCredit - customerAvailableCredit - remark - metadata - createdAt - updatedAt - currency DisburseDrawdownResponse: type: object properties: statusCode: type: number default: 200 description: The HTTP status code of the error data: description: Response Data from the operation allOf: - $ref: '#/components/schemas/DisburseLoanStatusResponse' message: type: string default: Success description: Human-readable message containing all available details about the operation success: type: boolean default: true description: A boolean indicating whether this was a success response or an error response required: - statusCode - data - message - success DrawdownNotFoundResponse: type: object properties: statusCode: type: number default: 404 description: The HTTP status code of the error error: type: string default: string description: Human-readable generic error message errorCode: type: string default: E_D_NOT_FOUND description: Computer-readable code for error handling message: type: string default: string description: Human-readable error message containing all available details about how the error occurred success: type: boolean default: false description: A boolean indicating whether this was a success response or an error response required: - statusCode - error - errorCode - message - success GetLoanSummaryResponse: type: object properties: statusCode: type: number default: 200 description: The HTTP status code of the error data: description: Response Data from the operation allOf: - $ref: '#/components/schemas/LoanSummaryResponse' message: type: string default: Success description: Human-readable message containing all available details about the operation success: type: boolean default: true description: A boolean indicating whether this was a success response or an error response required: - statusCode - data - message - success MakeLoanPaymentV1Dto: type: object properties: loanId: type: string default: '' example: c3eb1619-ff24-4773-97d8-b05264621e60 description: Loan Id, for which you want to make payment paymentAmount: type: number example: 1000 description: "Payment Amount.\n \n - Support decimal values as well." paymentTypeId: type: number example: 1 description: "We have 3 types of payments. \n \n For payment via bank transfer: ```1``` \n \n For payment\ \ using UEN number: ```2```\n \n For payment using QR code: ```3```" paymentReferenceNo: type: string example: asd123 description: Payment reference number. required: - loanId - paymentAmount - paymentTypeId MakeLoanPaymentResponse: type: object properties: statusCode: type: number default: 200 description: The HTTP status code of the error data: description: Response Data from the operation allOf: - $ref: '#/components/schemas/LoanPayment' message: type: string default: Success description: Human-readable message containing all available details about the operation success: type: boolean default: true description: A boolean indicating whether this was a success response or an error response required: - statusCode - data - message - success VerifyPaymentV1Dto: type: object properties: paymentId: type: string description: Payment Id. remark: type: string description: Comments if any. default: Received required: - paymentId - remark VerifyPayment: type: object properties: paymentId: type: string default: string description: Id of the payment paymentDate: type: string default: '2025-01-08T05:12:17.404Z' description: Date of the payment in UTC Format eg. 2023-03-30T11:46:42.195Z paymentAmount: type: number default: 1000 description: Payment Amount paymentMethod: type: string default: 1000 description: Payment Amount example: Bank Transfer/UEN Payment/QR Code Payment paymentReferenceNo: type: string default: string description: Payment reference number provided while making payment accountNumber: type: string default: string description: "Account Number varies based on payment types.\n \n\nSo for bank transfer payment( this field\ \ will contain ```bank account number``` & for UEN number payment this will contain ```UEN Number```" accountName: type: string default: string description: Account Name to which payment has been made. bankName: type: string default: string description: "Bank Name varies based on payment types.\n \n\nSo for bank transfer payment this field will be\ \ present, for rest of the types it will be empty" bankSwiftCode: type: string default: string description: "Bank Swift Code varies based on payment types.\n \n\nSo for bank transfer payment this field\ \ will be present, for rest of the types it will be empty" paymentStatus: type: number default: 2 description: "We have 3 types of payment status codes. \n \n For payment rejected: ```0``` \n \n For payment\ \ done, but verification pending: ```1```\n \n For payment done & verified: ```2```" loanId: type: string default: string description: Loan Id, for which payment has been made. customerReferenceNo: type: string default: string description: Customer Reference Number, for which payment has been made. metadata: type: string default: string description: Metadata for payments. It can be used for reporting, reconciliation purpose. createdAt: type: string default: '2025-01-08T05:12:17.405Z' description: Created Timestamp of the payment in UTC Format eg. 2023-03-30T11:46:42.195Z updatedAt: type: string default: '2025-01-08T05:12:17.405Z' description: Updated Timestamp of the payment in UTC Format eg. 2023-03-30T11:46:42.195Z currency: type: string default: SGD description: Currency Code remark: type: string default: string description: Payment Remark required: - paymentId - paymentDate - paymentAmount - paymentMethod - paymentReferenceNo - accountNumber - accountName - bankName - bankSwiftCode - paymentStatus - loanId - customerReferenceNo - metadata - createdAt - updatedAt - currency - remark VerifyLoanPaymentsResponse: type: object properties: statusCode: type: number default: 201 description: The HTTP status code of the error data: description: Response Data from the operation allOf: - $ref: '#/components/schemas/VerifyPayment' message: type: string default: Success description: Human-readable message containing all available details about the operation success: type: boolean default: true description: A boolean indicating whether this was a success response or an error response required: - statusCode - data - message - success GetLoanPaymentsResponse: type: object properties: statusCode: type: number default: 200 description: The HTTP status code of the error data: description: Response Data from the operation type: array items: $ref: '#/components/schemas/LoanPayment' message: type: string default: Success description: Human-readable message containing all available details about the operation success: type: boolean default: true description: A boolean indicating whether this was a success response or an error response required: - statusCode - data - message - success CustomerSummaryResponse: type: object properties: customerName: type: string description: Customer or a Company's Full Name default: John Doe customerEmail: type: string description: Email address of Customer/company which is used for login to B2B PayLater portal default: johndoe2@gmail.com mobileNo: type: string description: Company/Customer's Mobile number along with country code default: '7744559977' businessRegistrationNo: type: string description: Business Registration Number is a company registration number provided by the government agency default: '' customerReferenceNo: type: string default: string description: Customer Reference number this will be used to execute all APIs further to activate customer, to create loan and so on availableCredit: type: number default: 10000 description: Customer's available credit limit approvedCredit: type: number default: 15000 description: Customer's approved credit limit totalOutstandingAmount: type: number default: 1500000 description: Total payable outstanding amount by customer loans: description: All loans of customer type: array items: $ref: '#/components/schemas/LoanSummaryResponse' createdAt: type: string default: '2025-01-08T05:12:17.406Z' description: Created Timestamp of the customer in UTC Format eg. 2023-03-30T11:46:42.195Z updatedAt: type: string default: '2025-01-08T05:12:17.406Z' description: Updated Timestamp of the customer in UTC Format eg. 2023-03-30T11:46:42.195Z required: - customerName - customerEmail - mobileNo - businessRegistrationNo - customerReferenceNo - availableCredit - approvedCredit - totalOutstandingAmount - loans - createdAt - updatedAt PartnerDashboardResponse: type: object properties: partnerId: type: string default: string description: Id of the partner mobileNo: type: string default: string description: Mobile No of the partner companyEmail: type: string default: string description: Email Address of the partner's company companyName: type: string default: string description: Name of the partner's company positionWithinCompany: type: string default: string description: Position of the partner in company customers: type: array items: $ref: '#/components/schemas/CustomerSummaryResponse' createdAt: type: string default: '2025-01-08T05:12:17.426Z' description: Created Timestamp of the partner in UTC Format eg. 2023-03-30T11:46:42.195Z updatedAt: type: string default: '2025-01-08T05:12:17.426Z' description: Updated Timestamp of the partner in UTC Format eg. 2023-03-30T11:46:42.195Z required: - partnerId - mobileNo - companyEmail - companyName - positionWithinCompany - customers - createdAt - updatedAt GetPartnerDashboardResponse: type: object properties: statusCode: type: number default: 200 description: The HTTP status code of the error data: description: Response Data from the operation allOf: - $ref: '#/components/schemas/PartnerDashboardResponse' message: type: string default: Success description: Human-readable message containing all available details about the operation success: type: boolean default: true description: A boolean indicating whether this was a success response or an error response required: - statusCode - data - message - success PartnerNotFoundResponse: type: object properties: statusCode: type: number default: 404 description: The HTTP status code of the error error: type: string default: string description: Human-readable generic error message errorCode: type: string default: E_P_PARTNER_NOT_FOUND description: Computer-readable code for error handling message: type: string default: string description: Human-readable error message containing all available details about how the error occurred success: type: boolean default: false description: A boolean indicating whether this was a success response or an error response required: - statusCode - error - errorCode - message - success GetPartnerReportDTO: type: object properties: limit: type: number example: 7 description: Limit skip: type: number example: 0 description: Skip sortColumn: type: string example: finractDueDate | finractSubmittedOnDate | loanDisbursementDate | loanAmount description: Sort By Column enum: - finractDueDate - finractSubmittedOnDate - loanDisbursementDate - loanAmount sortDirection: type: string example: asc | desc description: Sorting Direction actualDisbursementDateLte: type: string description: Actual Disbursement Date Less Than or Equal To example: YYYY-MM-DD actualDisbursementDateGte: type: string description: Actual Disbursement Date Greater Than or Equal To example: YYYY-MM-DD loanType: type: string description: "\nType of loan.\n \n We support these two types,\n \n 1. ```BNPL``` - Buyer Financing\n \n\ \ 2. ```GMV``` - Seller Financing" enum: - BNPL - GMV - BNPL_Term - GMV_Term example: BNPL clientId: type: string description: Client ID example: 12345678-1234-1234-1234-123467890123 clientIdIn: description: Client IDs (in array) example: - 12345678-1234-1234-1234-123467890123 type: array items: type: string paymentAmountLTE: type: number description: Payment Amount Less Than or Equal To example: 1000 paymentAmountGTE: type: number description: Payment Amount Greater Than or Equal To example: 1000 status: type: number description: Status statusIn: description: Statuses (in array) type: array items: type: number GetCustomerDashboardResponse: type: object properties: statusCode: type: number default: 200 description: The HTTP status code of the error data: description: Response Data from the operation allOf: - $ref: '#/components/schemas/CustomerSummaryResponse' message: type: string default: Success description: Human-readable message containing all available details about the operation success: type: boolean default: true description: A boolean indicating whether this was a success response or an error response required: - statusCode - data - message - success CreditHistoryResponse: type: object properties: customerReferenceNo: type: string default: string description: Customer Reference number this will be used to execute all APIs further to activate customer, to create loan and so on availableCredit: type: number default: 10000 description: Customer's available credit limit approvedCredit: type: number default: 15000 description: Customer's approved credit limit createdAt: type: string default: 2023-01-25T05:47:33.215Z01 description: Created Timestamp of the Credit History in UTC Format eg. 2023-03-30T11:46:42.195Z updatedAt: type: string default: 2023-01-25T05:47:33.215Z01 description: Updated Timestamp of the Credit History in UTC Format eg. 2023-03-30T11:46:42.195Z currency: type: string default: SGD description: Currency Code required: - customerReferenceNo - availableCredit - approvedCredit - createdAt - updatedAt - currency GetAllCreditHistoryResponse: type: object properties: statusCode: type: number default: 200 description: The HTTP status code of the error data: description: Response Data from the operation type: array items: $ref: '#/components/schemas/CreditHistoryResponse' message: type: string default: Success description: Human-readable message containing all available details about the operation success: type: boolean default: true description: A boolean indicating whether this was a success response or an error response required: - statusCode - data - message - success GetPostalCodes: type: object properties: postalCodes: description: Available Postal Codes of the country type: array items: type: string required: - postalCodes GetPostalCodesResponse: type: object properties: statusCode: type: number default: 200 description: The HTTP status code of the error data: description: Response Data from the operation allOf: - $ref: '#/components/schemas/GetPostalCodes' message: type: string default: Success description: Human-readable message containing all available details about the operation success: type: boolean default: true description: A boolean indicating whether this was a success response or an error response required: - statusCode - data - message - success Country: type: object properties: country: type: string description: Name of the country countryCode: type: string description: Code of the country required: - country - countryCode GetCountries: type: object properties: countries: description: Available Counties type: array items: $ref: '#/components/schemas/Country' required: - countries GetCountriesResponse: type: object properties: statusCode: type: number default: 200 description: The HTTP status code of the error data: description: Response Data from the operation allOf: - $ref: '#/components/schemas/GetCountries' message: type: string default: Success description: Human-readable message containing all available details about the operation success: type: boolean default: true description: A boolean indicating whether this was a success response or an error response required: - statusCode - data - message - success GetAddress: type: object properties: country: type: string description: Country Name state: description: Available States of the country by postal code type: array items: type: string district: description: Available Districts of the country by postal code type: array items: type: string city: description: Available Cities of the country by postal code type: array items: type: string area: description: Available Areas of the country by postal code type: array items: type: string required: - country - state - district - city - area GetAddressResponse: type: object properties: statusCode: type: number default: 200 description: The HTTP status code of the error data: description: Response Data from the operation allOf: - $ref: '#/components/schemas/GetAddress' message: type: string default: Success description: Human-readable message containing all available details about the operation success: type: boolean default: true description: A boolean indicating whether this was a success response or an error response required: - statusCode - data - message - success GetDocumentTypes: type: object properties: id: type: string description: Document Type Id localName: type: string description: Document Type Id docType: type: string description: Document Type (Utility Bill/ Passport etc.) optional: type: boolean description: Is this document type optional or not. required: - id - localName - docType - optional GetDocumentTypesResponse: type: object properties: statusCode: type: number default: 200 description: The HTTP status code of the error data: description: Response Data from the operation allOf: - $ref: '#/components/schemas/GetDocumentTypes' message: type: string default: Success description: Human-readable message containing all available details about the operation success: type: boolean default: true description: A boolean indicating whether this was a success response or an error response required: - statusCode - data - message - success securitySchemes: access-token: scheme: bearer bearerFormat: JWT type: http tags: - name: Authentication - name: Onboarding - name: KYC - name: Customers - name: Loans - name: Payment - name: Report - name: Miscellaneous security: - access-token: []