-
Notifications
You must be signed in to change notification settings - Fork 4
Fr approvals docs #477
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.
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
Merged
Merged
Fr approvals docs #477
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
c445ffa
Document France PA agreement signing API
mrdanwa 0c76ffd
Add wizard path to France PA registration guide
mrdanwa c6258b9
Clarify identity requirement in agreement-upload doc
mrdanwa 9476def
Clarify identity document upload instructions
methodofaction File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| --- | ||
| title: "Generate agreement PDF" | ||
| title: "Download agreement PDF" | ||
| description: "Download the current agreement PDF for a silo entry. Returns the signed mandate if already signed, otherwise the unsigned template." | ||
| openapi: "GET /apps/gov-fr/v1/entry/{silo_entry_id}/agreement" | ||
| --- | ||
|
|
||
| Returns the unsigned mandate PDF that the signer must review and sign. The document is generated on the fly from the silo entry's draft party — the call fails with `422` when any required party or signer field is missing. | ||
| Returns the current agreement PDF. If the signer has already completed the signing step (`POST /sign` or `POST /agreement`), the signed mandate is returned. Otherwise the unsigned template is returned, pre-filled with the party's details. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,11 @@ | ||
| --- | ||
| title: "Upload signed agreement" | ||
| title: "Upload pre-signed agreement" | ||
| description: "Store a mandate signed outside Invopop on the silo entry." | ||
| openapi: "POST /apps/gov-fr/v1/entry/{silo_entry_id}/agreement" | ||
| --- | ||
|
|
||
| Stores the customer's signed PDF on the silo entry together with the chosen signature method. Two methods are accepted: `esignature` (PAdES — validated cryptographically against the EU Trusted List) and `identity` (hand-signed — verification deferred to Invopop's approval service, requires identity images uploaded via `POST /identity` first). | ||
| Stores a mandate the customer has signed outside Invopop. Satisfies the `agreement` step on the approval flow. | ||
|
|
||
| This call only persists the document. Call `POST /confirm` afterwards to mark the submission complete and let the onboarding workflow proceed. | ||
| Identity verification is still required. Call `POST /identity` before or after this endpoint, then call `POST /confirm` to finalise. | ||
|
|
||
| For in-app signing, use `POST /sign` instead. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,14 @@ | ||
| --- | ||
| title: "Confirm submission" | ||
| description: "Finalise the onboarding approval and advance the registration workflow." | ||
| openapi: "POST /apps/gov-fr/v1/entry/{silo_entry_id}/confirm" | ||
| --- | ||
|
|
||
| Marks the customer's submission as complete once the signed agreement (and any required identity images) have been uploaded. Records the decision in silo meta and pokes the queued `agreement.wait.approval` task so the onboarding workflow can continue. | ||
| Finalises the approval and pokes the queued `agreement.wait.approval` task so the onboarding workflow continues. Returns the approval flow status. | ||
|
|
||
| Identity verification (`POST /identity`) is required on both paths. In addition: | ||
|
|
||
| - **In-app signing**: `POST /sign` must have been called. | ||
| - **Pre-signed PDF**: `POST /agreement` must have been called. | ||
|
|
||
| A `submitted` status in the response means the submission is under review; the workflow advances once a decision is made. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,9 @@ | ||
| --- | ||
| title: "Upload identity image" | ||
| description: "Upload one face of the signer's identity document for verification." | ||
| openapi: "POST /apps/gov-fr/v1/entry/{silo_entry_id}/identity" | ||
| --- | ||
|
|
||
| Stores one face of the signer's identity document as an attachment on the silo entry. Required before confirming when the agreement was uploaded with `signature=identity`. Call once per view — `front` + `back` for an ID card (CNI, titre de séjour), or `page` for a passport. Re-uploading the same view overwrites the previous image; the MIME type is detected from the bytes. | ||
| Stores one face of the signer's identity document. Required on both signing paths. Call before `POST /confirm`. | ||
|
|
||
| Call once per side: `front` + `back` for an ID card (CNI, titre de séjour), or a single `page` for a passport. Re-uploading the same view overwrites the previous image. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| --- | ||
| title: "Sign agreement mandate" | ||
| description: "Stamp the signer's signature onto the mandate and store the result as the signed agreement." | ||
| openapi: "POST /apps/gov-fr/v1/entry/{silo_entry_id}/sign" | ||
| --- | ||
|
|
||
| Stamps the signer's signature onto the generated mandate PDF and stores the result as the entry's signed agreement. Satisfies the `sign` step on the approval flow. | ||
|
|
||
| Two modes: | ||
|
|
||
| - **Drawn**: pass a PNG or JPEG image in `signature` (≤ 4 MB). The image is inked onto the signature box. | ||
| - **Typed**: omit `signature`. The signer's name is rendered as a typed signature. | ||
|
mrdanwa marked this conversation as resolved.
mrdanwa marked this conversation as resolved.
|
||
|
|
||
| The silo entry must have signer fields set (given name, surname, and identity number) before calling. Use together with `POST /identity`, then call `POST /confirm` to finalise. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.