Generate Upload Link API

The document upload process is a mandatory step for all sub-account applications. The process involves multiple API calls to first generate a secure upload link, then upload the file, and finally link the uploaded document to the sub-account's application.

Step 1: Generate a Secure Upload Link First, you must generate a unique, one-time link to upload the document file.

• Endpoint: POST /documents/generate-upload-link
• Authentication: Requires the parentCompanyId auth token in the authorisation header.
• Payload:
  • fileName (string): The name of the file to be uploaded, including its extension (e.g., "utility-bill.pdf", "passport.jpeg").
  • documentTypeId (string): The static identifier for the document type being uploaded (see Document ID section).

Step 2: Upload the File Use the link provided in the response from Step 1 to upload the binary file.

• Endpoint: The link URL returned in the previous step's response.
• Method: PUT
• Body: The raw binary data of the file.

Step 3: Receive the unique key

In the response to the Document Upload API, you will receive a unique key to use in the Add Onboarding Data API call to link uploaded supporting documents.

Step 4: Link the Document to the Sub-Account Finally, map the key received in the Step 1 response to the sub-account's onboarding data. This links the uploaded file to the correct document type in the application.

• Endpoint: Add Onboarding data
• Payload Snippet: Within the companyDocuments or shareholderDocuments array, include an object with the typeId and map the key to the link property.

  "typeId": "66d2938475a40aae623126e1",
  "link": "a484j93-d7f5-5b12-f863-db44c454c25e-Sample.pdf"
}