From 458285ff07dc6b2dbc44b67a40cf9e1ecae2cfe5 Mon Sep 17 00:00:00 2001 From: Maxence Busson Date: Wed, 7 Jan 2026 20:26:10 +0100 Subject: [PATCH] DOC-656/add-hint-that-file-format-must-be-given-in-the-upload-required --- .../accounts/documents/guide-upload-onboarding.mdx | 8 ++++++-- .../accounts/documents/guide-upload-transaction.mdx | 4 ++++ .../capital-deposits/france/guide-upload-documents.mdx | 10 +++++++--- 3 files changed, 17 insertions(+), 5 deletions(-) diff --git a/docs/topics/accounts/documents/guide-upload-onboarding.mdx b/docs/topics/accounts/documents/guide-upload-onboarding.mdx index 24867d5d95..954307ccdb 100644 --- a/docs/topics/accounts/documents/guide-upload-onboarding.mdx +++ b/docs/topics/accounts/documents/guide-upload-onboarding.mdx @@ -21,14 +21,18 @@ Use the API to upload required documents in three steps. 1. Add the `GenerateSupportingDocumentUploadUrlSuccessPayload` with required `key/value` pairs and `url`. 1. Add other optional messages to the payload, either for validation or in case of rejection. -Open in API Explorer +:::info Filename format +The `filename` must include a valid file extension: `.heic`, `.jpg`, `.pdf`, or `.png`. +::: + +Open in API Explorer ```graphql {4-7,13-15,17} showLineNumbers mutation GenerateUploadUrl { generateSupportingDocumentUploadUrl( input: { supportingDocumentCollectionId: "$COLLECTION_ID" - filename: "$DOCUMENT_FILE" + filename: "Company_Registration.pdf" supportingDocumentPurpose: CompanyRegistration supportingDocumentType: RegisterExtract } diff --git a/docs/topics/accounts/documents/guide-upload-transaction.mdx b/docs/topics/accounts/documents/guide-upload-transaction.mdx index d5c40a6fbe..485044d5de 100644 --- a/docs/topics/accounts/documents/guide-upload-transaction.mdx +++ b/docs/topics/accounts/documents/guide-upload-transaction.mdx @@ -24,6 +24,10 @@ Don't continue until you've successfully initiated a transaction—you'll need t 1. Add the `GenerateTransactionSupportingDocumentUploadUrlSuccessPayload` with required `key/value` pairs and `url` (lines 14-16, 18). 1. Add other optional messages to the payload, either for validation or in case of rejection (rejections not shown). +:::info Filename format +The `filename` must include a valid file extension: `.heic`, `.jpg`, `.pdf`, or `.png`. +::: + Open in API Explorer ```graphql {4-6,14-16,18} showLineNumbers diff --git a/docs/topics/capital-deposits/france/guide-upload-documents.mdx b/docs/topics/capital-deposits/france/guide-upload-documents.mdx index db4130c30e..30c1ca3274 100644 --- a/docs/topics/capital-deposits/france/guide-upload-documents.mdx +++ b/docs/topics/capital-deposits/france/guide-upload-documents.mdx @@ -18,7 +18,11 @@ Use the `generateCapitalDepositDocumentUploadUrl` mutation to generate an upload 1. Add the `GenerateSupportingDocumentUploadUrlSuccessPayload` with the `uploadUrl`. 1. Add other optional messages to the payload, either for validation or in case of rejection. -Open in API Explorer +:::info Filename format +The `filename` must include a valid file extension: `.pdf`, `.png`, or `.jpg`. +::: + +Open in API Explorer ```graphql {2,4-6,10} showLineNumbers mutation generateUploadUrl { @@ -26,7 +30,7 @@ mutation generateUploadUrl { input: { documentId: "$YOUR_DOCUMENT_ID" capitalDepositCaseId: "$YOUR_CAPITALDEPOSITCASE_ID" - filename: "$FILE_NAME" + filename: "Articles_Of_Incorporation.pdf" } ) { ... on GenerateCapitalDepositDocumentUploadUrlSuccessPayload { @@ -44,7 +48,7 @@ Retrieve the generated `uploadUrl` in the payload. The `uploadUrl` is **only valid for seven days**, after which you'd need to generate a new URL. ::: -```graphql {4} showLineNumbers +```json {4} showLineNumbers { "data": { "generateCapitalDepositDocumentUploadUrl": {