KYB — Know Your Business
Verify legal entities (LLCs, corporations, trusts) alongside their controlling parties. Heimdall captures beneficial owners, business documents, and ultimate beneficiaries in a single workflow.
What you can do
- Register a business entity with jurisdiction and formation details
- Attach controlling parties and their individual KYC results
- Upload formation documents, articles of incorporation, tax IDs
- Track status and re-verify on periodic review cycles
Endpoints
GET
List KYB attempts for a user
/kyb
POST
Initiate Kyb
/kyb/initiate
GET
Get Kyb Status
/kyb/status
POST
Submit Qib Attestation
/kyb/qib/attest
PATCH
Review Qib
/kyb/{userId}/review
POST
Handle Compilot Webhook
/kyb/webhook/compilot
GET
List all KYB records for a tenant (admin)
/kyb/kybs/all
GET
Get a KYB record by ID
/kyb/{kybId}
PATCH
Update a KYB record
/kyb/{kybId}
PUT
Approve a KYB submission
/kyb/approve/{kybId}
PUT
Reject a KYB submission
/kyb/reject/{kybId}
PUT
Request KYB resubmission from entity
/kyb/resubmit/{kybId}
POST
Create a manual KYB submission
/kyb/manual
PATCH
Update a manual KYB record
/kyb/manual/{kybId}
GET
List all documents linked to a KYB record
/kyb/{kybId}/documents
POST
Link a document to a KYB record
/kyb/{kybId}/documents
POST
Link multiple documents to a KYB record in bulk
/kyb/{kybId}/documents/bulk
GET
Get the file for a KYB document link
/kyb/file/{kybDocumentId}
DELETE
Unlink a document from a KYB record
/kyb/{kybId}/documents/{kybDocumentId}
PATCH
Update notes on a KYB document link
/kyb/documents/{kybDocumentId}