CRcredilinq
KYC

Initiate Customer KYC

post/v2/kyc/customer/create

Request

  • Base URL
    https://api.credilinq.ai
  • URL
    https://api.credilinq.ai/v2/kyc/customer/create
  • Auth
    HTTP bearer

Headers

accept-languagestring

Language of the response, supported languages: en-us, in

Request body multipart/form-data

customerReferenceNostring required

Customer reference number

customerNamestring required

Customer or a Company's Full Name.

  • /^(?:(?=^.*([0-9]|[a-z]|[A-Z]))(([0-9]|[a-z]|[A-Z]))|([0-9]|[a-z]|[A-Z]))/g

Shouldn't match:

  • /^\d+$/

  • /^[\W_]+$/

customerEmailstring required

Email address of Customer/company which is used for login to B2B PayLater portal.

  • Email address which was used to check eligibility and initiate application.

  • Should be valid email.

companyRegistrationNostring required

Registration number with which company is registered.

  • /^[A-Za-z0-9/-]+$/
companyRegistrationDatestring required

Company Registration Date is a date at which company is registered. Supported Date Formats (DD-MM-YYYY/DD MMM YYYY)

incorporationCountrystring required

Country of incorporation for company.

Shouldn't match:

  • /^\d+$/

  • /^[\W_]+$/

industry'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' required

Industry indicates the type of activity in which company is involved. For eg. Travel, Media, Manufacuring etc

addressstring required

Address of company.

  • /^(?:(?=^.*([0-9]|[a-z]|[A-Z]))(([0-9]|[a-z]|[A-Z]))|([0-9]|[a-z]|[A-Z]))/g

Shouldn't match:

  • /^\d+$/

  • /^[\W_]+$/

zipCodestring required

ZipCode/PinCode for address.

  • /^[A-Za-z0-9]+$/

Shouldn't match:

  • /^[\W_]+$/
statestring required

State in which company is located.

Shouldn't match:

  • /^\d+$/

  • /^[\W_]+$/

districtstring required

District in which company is located.

Shouldn't match:

  • /^\d+$/

  • /^[\W_]+$/

citystring required

City in which company is located.

Shouldn't match:

  • /^\d+$/

  • /^[\W_]+$/

areastring required

Area in which company is located.

Shouldn't match:

  • /^\d+$/

  • /^[\W_]+$/

streetstring

Street in which company is located.

Shouldn't match:

  • /^\d+$/

  • /^[\W_]+$/

countrystring required

Country in which company is located.

Shouldn't match:

  • /^\d+$/

  • /^[\W_]+$/

mobileNostring required

Company/Customer's Mobile number along with country code.

  • <= 15 characters
  • /^(\+\d{1,4}[-. ]?)?(\()?\d{3}(\))?[-. ]?\d{3}[-. ]?\d{3,4}$/
companyDescriptionstring required

Some description of company

Shouldn't match:

  • /^\d+$/

  • /^[\W_]+$/

taxIdNumberstring required

Registered tax identifixation number for company

  • /^[A-Za-z0-9+-]+$/

Shouldn't match:

  • /^[a-z]+$/i

  • /^[\W_]+$/

bankNamestring

Bank name where company account is.

Shouldn't match:

  • /^\d+$/

  • /^[\W_]+$/

bankAccountNumbernumber

Account number of company account.

bankSwiftCodestring

Bank Swift code.

  • /^[A-Za-z0-9]+$/

Shouldn't match:

  • /^[\W_]+$/
bankAccountNamestring

Bank Account Name.

Shouldn't match:

  • /^\d+$/

  • /^[\W_]+$/

bankAddressstring

Bank Address.

Shouldn't match:

  • /^\d+$/

  • /^[\W_]+$/

intermediaryBankNamestring

Intermediary Bank Name where company account is.

Shouldn't match:

  • /^\d+$/

  • /^[\W_]+$/

intermediaryBankSWIFTCodestring

Intermediary Bank Swift code.

  • /^[A-Za-z0-9]+$/

Shouldn't match:

  • /^[\W_]+$/
wireRemittanceRouteNumberstring

Wire Remittance Route Number.

  • <= 20 characters
  • /^\d+$/
achRoutingNumberstring

ACH Routing Number.

  • <= 20 characters
  • /^\d+$/
filesstring[] required

Customer KYC Documents

applicationIdstring required

Application Id

Example request

{
  "customerReferenceNo": "c3eb1619-ff24-4773-97d8-b05264621e60",
  "customerName": "John Doe",
  "customerEmail": "johndoe2@gmail.com",
  "companyRegistrationNo": "1111111ET",
  "companyRegistrationDate": "13-07-2023",
  "incorporationCountry": "Singapore",
  "industry": "IT services",
  "address": "100 North St, Singapore",
  "zipCode": "155010",
  "state": "Central Region",
  "district": "Bedok",
  "city": "Downtown",
  "area": "PC garden",
  "street": "SD School St",
  "country": "Singapore",
  "mobileNo": "+6578787141",
  "companyDescription": "An Insurance company...",
  "taxIdNumber": "12155154",
  "bankName": "DBS Bank",
  "bankAccountNumber": 7818154515215451,
  "bankSwiftCode": "78948142",
  "bankAccountName": "HEALTHIFY INC.",
  "bankAddress": "78 South Region, Singapore",
  "intermediaryBankName": "DBS Bank",
  "intermediaryBankSWIFTCode": "78948142",
  "wireRemittanceRouteNumber": "074000078",
  "achRoutingNumber": "074000078",
  "applicationId": "d8eb1219-gg24-4773-97d8-b05264621e60"
}

Response

Customer KYC Created

statusCodenumber required

The HTTP status code of the error

messagestring required

Human-readable message containing all available details about the operation

successboolean required

A boolean indicating whether this was a success response or an error response

Changes

No recorded changes to this operation across all 11 revisions of this API.