CRcredilinq
KYC

Initiate Director KYC

post/v2/kyc/director/create

Request

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

Headers

accept-languagestring

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

Request body multipart/form-data

directorNamestring required

Name of the director.

Shouldn't match:

  • /^\d+$/

  • /^[\W_]+$/

personalIdentificationNumberstring required

Personal identification number.

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

Shouldn't match:

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

The amount of shares that director owns in a company or business

emailstring required

Email address of director.

addressstring required

Address of director.

Shouldn't match:

  • /^\d+$/

  • /^[\W_]+$/

zipCodestring required

ZipCode/PinCode for address.

Shouldn't match:

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

State of the director

Shouldn't match:

  • /^\d+$/

  • /^[\W_]+$/

districtstring

District of the director

Shouldn't match:

  • /^\d+$/

  • /^[\W_]+$/

citystring

City of the director

Shouldn't match:

  • /^\d+$/

  • /^[\W_]+$/

areastring

Area of the director

Shouldn't match:

  • /^\d+$/

  • /^[\W_]+$/

streetstring

Street in which director is located.

Shouldn't match:

  • /^\d+$/

  • /^[\W_]+$/

phonestring required

Contact phone number of director.

Shouldn't match:

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

Country of director.

Shouldn't match:

  • /^\d+$/

  • /^[\W_]+$/

filesstring[]

Director KYC Documents

status'active' | 'inactive' required

Director Status

applicationIdstring required

Application Id

businessIdstring required

Business Id

Example request

{
  "directorName": "Marques Brownlee",
  "personalIdentificationNumber": "B88964115515A",
  "shareholding": "10",
  "email": "m.brownlee@healthify.com",
  "address": "45 West Region, Singpoare",
  "zipCode": "79581",
  "state": "Central Region",
  "district": "Bedok",
  "city": "Downtown",
  "area": "PC garden",
  "street": "SD School St",
  "phone": "+6545457414",
  "country": "Singapore",
  "status": "active",
  "applicationId": "d8eb1219-gg24-4773-97d8-b05264621e60",
  "businessId": "d8eb1219-gg24-4773-97d8-b05264621e60"
}

Response

Director 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.