Skip to content
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

chore(qes): add documents endpoint #99

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,9 @@ paths:
$ref: paths/id_photos.yaml#/id_photo
/id_photos/{id_photo_id}/download:
$ref: paths/id_photos.yaml#/download
# Qualified Electronic Signature
/qualified_electronic_signature/documents:
$ref: paths/qualified_electronic_signature.yaml#/documents
# Timeline Files
/workflow_runs/{workflow_run_id}/timeline_file:
$ref: paths/timeline_files.yaml#/timeline_files
Expand Down
40 changes: 40 additions & 0 deletions paths/qualified_electronic_signature.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
documents:
post:
summary: Retrieves the signed document or application form
operationId: download_qes_document
description: >
Retrieves the signed document or application form depending on the file_id provided.
parameters:
- name: workflow_run_id
in: query
required: true
description: The unique identifier of the Workflow Run for which you want to retrieve the signed document.
schema:
type: string
format: uuid
- name: file_id
in: query
required: true
description: The unique identifier of the file which you want to retrieve.
schema:
type: string
format: uuid

responses:
"302":
description: Found
headers:
Location:
description: Pre-signed URL to download the file.
schema:
type: string
format: uri
dvacca-onfido marked this conversation as resolved.
Show resolved Hide resolved
"200":
description: The signed document PDF binary data.
content:
application/pdf:
schema:
type: string
format: binary
default:
$ref: ../responses/default_error.yaml
1 change: 1 addition & 0 deletions shell/patch-openapi-definition.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ class Section:
'motion_captures': 'Motion captures',
'watchlist_monitors': 'Monitors',
'id_photos': 'ID Photos',
'qualified_electronic_signature': 'Qualified Electronic Signature',
'timeline_file': 'Timeline Files'
}),
Section('Other Endpoints',
Expand Down