Skip to content

DOC-656/add-hint-that-file-format-must-be-given-in-the-upload-required #528

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
max-koro wants to merge 1 commit into
base: main
Choose a base branch
from
Open

DOC-656/add-hint-that-file-format-must-be-given-in-the-upload-required #528

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/topics/accounts/documents/guide-upload-onboarding.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<a href="https://explorer.swan.io?query=bXV0YXRpb24gVXBsb2FkRG9jdW1lbnRzIHsKICBnZW5lcmF0ZVN1cHBvcnRpbmdEb2N1bWVudFVwbG9hZFVybCgKICAgIGlucHV0OiB7CiAgICAgIHN1cHBvcnRpbmdEb2N1bWVudENvbGxlY3Rpb25JZDogIiRDT0xMRUNUSU9OX0lEIgogICAgICBmaWxlbmFtZTogIiRET0NVTUVOVF9GSUxFX05BTUUiCiAgICAgIHN1cHBvcnRpbmdEb2N1bWVudFB1cnBvc2U6IENvbXBhbnlSZWdpc3RyYXRpb24KICAgICAgc3VwcG9ydGluZ0RvY3VtZW50VHlwZTogUmVnaXN0ZXJFeHRyYWN0CiAgICB9CiAgKSB7CiAgICAuLi4gb24gR2VuZXJhdGVTdXBwb3J0aW5nRG9jdW1lbnRVcGxvYWRVcmxTdWNjZXNzUGF5bG9hZCB7CiAgICAgIF9fdHlwZW5hbWUKICAgICAgdXBsb2FkIHsKICAgICAgICBmaWVsZHMgewogICAgICAgICAga2V5CiAgICAgICAgICB2YWx1ZQogICAgICAgIH0KICAgICAgICB1cmwKICAgICAgfQogICAgfQogIH0KfQ%3D%3D&tab=api" className="explorer-badge">Open in API Explorer</a>
:::info Filename format
The `filename` must include a valid file extension: `.heic`, `.jpg`, `.pdf`, or `.png`.
:::

<a href="https://explorer.swan.io?query=bXV0YXRpb24gR2VuZXJhdGVVcGxvYWRVcmwgewogIGdlbmVyYXRlU3VwcG9ydGluZ0RvY3VtZW50VXBsb2FkVXJsKAogICAgaW5wdXQ6IHsKICAgICAgc3VwcG9ydGluZ0RvY3VtZW50Q29sbGVjdGlvbklkOiAiJENPTExFQ1RJT05fSUQiCiAgICAgIGZpbGVuYW1lOiAiQ29tcGFueV9SZWdpc3RyYXRpb24ucGRmIgogICAgICBzdXBwb3J0aW5nRG9jdW1lbnRQdXJwb3NlOiBDb21wYW55UmVnaXN0cmF0aW9uCiAgICAgIHN1cHBvcnRpbmdEb2N1bWVudFR5cGU6IFJlZ2lzdGVyRXh0cmFjdAogICAgfQogICkgewogICAgLi4uIG9uIEdlbmVyYXRlU3VwcG9ydGluZ0RvY3VtZW50VXBsb2FkVXJsU3VjY2Vzc1BheWxvYWQgewogICAgICBfX3R5cGVuYW1lCiAgICAgIHVwbG9hZCB7CiAgICAgICAgZmllbGRzIHsKICAgICAgICAgIGtleQogICAgICAgICAgdmFsdWUKICAgICAgICB9CiAgICAgICAgdXJsCiAgICAgIH0KICAgIH0KICB9Cn0K&tab=api" className="explorer-badge">Open in API Explorer</a>

```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
}
Expand Down
4 changes: 4 additions & 0 deletions docs/topics/accounts/documents/guide-upload-transaction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
:::

<a href="https://explorer.swan.io?query=bXV0YXRpb24gVHJhbnNhY3Rpb25Eb2N1bWVudFVybCB7CiAgZ2VuZXJhdGVUcmFuc2FjdGlvblN1cHBvcnRpbmdEb2N1bWVudFVwbG9hZFVybCgKICAgIGlucHV0OiB7CiAgICAgIHRyYW5zYWN0aW9uSWQ6ICIkVFJBTlNBQ1RJT05fSUQiCiAgICAgIGZpbGVuYW1lOiAiZXhhbXBsZS5wZGYiCiAgICAgIHN1cHBvcnRpbmdEb2N1bWVudFB1cnBvc2U6IFByb29mT2ZPcmlnaW5PZkZ1bmRzCiAgICB9CiAgKSB7CiAgICAuLi4gb24gR2VuZXJhdGVUcmFuc2FjdGlvblN1cHBvcnRpbmdEb2N1bWVudFVwbG9hZFVybFN1Y2Nlc3NQYXlsb2FkIHsKICAgICAgX190eXBlbmFtZQogICAgICBzdXBwb3J0aW5nRG9jdW1lbnRDb2xsZWN0aW9uSWQKICAgICAgc3VwcG9ydGluZ0RvY3VtZW50SWQKICAgICAgdXBsb2FkIHsKICAgICAgICBmaWVsZHMgewogICAgICAgICAga2V5CiAgICAgICAgICB2YWx1ZQogICAgICAgIH0KICAgICAgICB1cmwKICAgICAgfQogICAgfQogICAgLi4uIG9uIEFjY291bnROb3RGb3VuZFJlamVjdGlvbiB7CiAgICAgIGlkCiAgICAgIG1lc3NhZ2UKICAgIH0KICAgIC4uLiBvbiBGb3JiaWRkZW5SZWplY3Rpb24gewogICAgICBfX3R5cGVuYW1lCiAgICAgIG1lc3NhZ2UKICAgIH0KICAgIC4uLiBvbiBJbnRlcm5hbEVycm9yUmVqZWN0aW9uIHsKICAgICAgX190eXBlbmFtZQogICAgICBtZXNzYWdlCiAgICB9CiAgICAuLi4gb24gVHJhbnNhY3Rpb25Ob3RGb3VuZFJlamVjdGlvbiB7CiAgICAgIF9fdHlwZW5hbWUKICAgICAgbWVzc2FnZQogICAgICB0cmFuc2FjdGlvbklkCiAgICB9CiAgICAuLi4gb24gVmFsaWRhdGlvblJlamVjdGlvbiB7CiAgICAgIF9fdHlwZW5hbWUKICAgICAgbWVzc2FnZQogICAgICBmaWVsZHMgewogICAgICAgIGNvZGUKICAgICAgICBtZXNzYWdlCiAgICAgICAgcGF0aAogICAgICB9CiAgICB9CiAgfQp9Cg%3D%3D&tab=api" className="explorer-badge">Open in API Explorer</a>

```graphql {4-6,14-16,18} showLineNumbers
Expand Down
10 changes: 7 additions & 3 deletions docs/topics/capital-deposits/france/guide-upload-documents.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,19 @@ 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.

<a href="https://explorer.swan.io?query=bXV0YXRpb24gZ2VuZXJhdGVVcGxvYWRVcmwgewogIGdlbmVyYXRlQ2FwaXRhbERlcG9zaXREb2N1bWVudFVwbG9hZFVybCgKICAgIGlucHV0OiB7CiAgICAgIGRvY3VtZW50SWQ6ICIkWU9VUl9ET0NVTUVOVF9JRCIKICAgICAgY2FwaXRhbERlcG9zaXRDYXNlSWQ6ICIkWU9VUl9DQVBJVEFMREVQT1NJVENBU0VfSUQiCiAgICAgIGZpbGVuYW1lOiAiJEZJTEVfTkFNRSIKICAgIH0KICApIHsKICAgIC4uLiBvbiBHZW5lcmF0ZUNhcGl0YWxEZXBvc2l0RG9jdW1lbnRVcGxvYWRVcmxTdWNjZXNzUGF5bG9hZCB7CiAgICAgIHVwbG9hZFVybAogICAgfQogIH0KfQo%3D&tab=api" className="explorer-badge">Open in API Explorer</a>
:::info Filename format
The `filename` must include a valid file extension: `.pdf`, `.png`, or `.jpg`.
:::

<a href="https://explorer.swan.io?query=bXV0YXRpb24gZ2VuZXJhdGVVcGxvYWRVcmwgewogIGdlbmVyYXRlQ2FwaXRhbERlcG9zaXREb2N1bWVudFVwbG9hZFVybCgKICAgIGlucHV0OiB7CiAgICAgIGRvY3VtZW50SWQ6ICIkWU9VUl9ET0NVTUVOVF9JRCIKICAgICAgY2FwaXRhbERlcG9zaXRDYXNlSWQ6ICIkWU9VUl9DQVBJVEFMREVQT1NJVENBU0VfSUQiCiAgICAgIGZpbGVuYW1lOiAiQXJ0aWNsZXNfT2ZfSW5jb3Jwb3JhdGlvbi5wZGYiCiAgICB9CiAgKSB7CiAgICAuLi4gb24gR2VuZXJhdGVDYXBpdGFsRGVwb3NpdERvY3VtZW50VXBsb2FkVXJsU3VjY2Vzc1BheWxvYWQgewogICAgICB1cGxvYWRVcmwKICAgIH0KICB9Cn0K&tab=api" className="explorer-badge">Open in API Explorer</a>

```graphql {2,4-6,10} showLineNumbers
mutation generateUploadUrl {
generateCapitalDepositDocumentUploadUrl(
input: {
documentId: "$YOUR_DOCUMENT_ID"
capitalDepositCaseId: "$YOUR_CAPITALDEPOSITCASE_ID"
filename: "$FILE_NAME"
filename: "Articles_Of_Incorporation.pdf"
}
) {
... on GenerateCapitalDepositDocumentUploadUrlSuccessPayload {
Expand All @@ -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": {
Expand Down