Submit borrower data (consent & onboarding link)

Due to privacy and data protection (NDPR & GDPR), this endpoint implies consent (user permission data) given by the borrower and helps onboard the borrower with these details on your Creditchek business dashboard to perform other assessments.

POST: https://api.creditchek.africa/v1/identity/widget/submit

Request Parameters

Name	Position	Required	Description
appId	body	True	your app ID
bvn	body	True	user bvn
fullName	body	True	user full name
email	body	True	user email
phoneNumber	body	True	user mobile no
gender	body	True	user gender
residentialAddress	body	True	user address
residenceType	body	True	e.g owned, rented, temporary
maritalStatus	body	True	single, married, divorced
dateOfBirth	body	False	date of birth

Optional paramters include: occupation, guarantorName, guarantorEmail, guarantorAddress, guarantorPhoneNumber, employerName, employerAddress, loanAmount and loanTenure

Example Request

---
curl --location --request POST 'https://api.creditchek.africa/v1/identity/widget/submit' \
--data-raw '{
    "fullName": "Lionel Orishane",
    "email": "[email protected]",
    "phoneNumber": "09070822819",
    "bvn": "22447917803",
    "residentialAddress": "PH, Rivers State, Nigeria",
    "residenceType": "owned",
    "appId": "622dff1cfea683001b7cc977",
    "maritalStatus": "single",
    "dateOfBirth": "18/02/2001",
    "gender": "male"
}'
---

Response

{
  status: true,
  data: [Object],
  message: "successful",
  error: false
}