Skip to main content

Initiate KYC

Initiates identity verification for the organization operating the dock. Required for production access.
POST /v1/docks/:id/kyc/initiate

Path Parameters

ParameterTypeDescription
idstringThe dock ID

Request Body

ParameterTypeRequiredDescription
businessNamestringRequiredLegal business name
businessTypestringRequiredEntity type (e.g., corporation, llc)
taxIdstringRequiredTax identification number
registrationNumberstringOptionalBusiness registration number
addressobjectRequiredBusiness address
address.streetstringRequiredStreet address
address.citystringRequiredCity
address.statestringRequiredState or province
address.postalCodestringRequiredPostal code
address.countrystringRequiredCountry code
contactInfoobjectRequiredContact details
contactInfo.emailstringRequiredContact email
contactInfo.phonestringRequiredContact phone
documentsarrayOptionalSupporting documents
documents[].typestringRequiredDocument type (e.g., articles_of_incorporation)
documents[].urlstringRequiredURL to the document

Example Request

curl -X POST https://api.docyard.io/v1/docks/dock_01HQ3K.../kyc/initiate \
  -H "Authorization: Bearer dk_live_a1b2c3d4..." \
  -H "Content-Type: application/json" \
  -d '{
    "businessName": "Acme Insurance Co.",
    "businessType": "corporation",
    "taxId": "12-3456789",
    "address": {
      "street": "100 Main St",
      "city": "Hartford",
      "state": "CT",
      "postalCode": "06103",
      "country": "US"
    },
    "contactInfo": {
      "email": "[email protected]",
      "phone": "+1-860-555-0100"
    }
  }'

Response

{
  "status": "PENDING",
  "referenceId": "kyc_ref_abc123...",
  "message": "KYC verification initiated"
}

Error Handling

StatusCondition
400Required fields missing (address, contactInfo)
401Missing or invalid API key
404Dock not found