Skip to content

Commit c479418

Browse files
Add /documents/{document_id}/nfc_face endpoint (#156)
This endpoint exists but wasn't present in the OpenAPI spec.
1 parent b625640 commit c479418

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

openapi.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ paths:
5454
$ref: paths/documents.yaml#/document
5555
/documents/{document_id}/download:
5656
$ref: paths/documents.yaml#/download
57+
/documents/{document_id}/nfc_face:
58+
$ref: paths/documents.yaml#/nfc_face
5759
/documents/{document_id}/video/download:
5860
$ref: paths/documents.yaml#/video/download
5961
# Live Photos

paths/documents.yaml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,30 @@ download:
9797
default:
9898
$ref: ../responses/default_error.yaml
9999

100+
nfc_face:
101+
get:
102+
summary: Download NFC face
103+
operationId: download_nfc_face
104+
description: >
105+
Downloads digital photos extracted from specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
106+
parameters:
107+
- name: document_id
108+
in: path
109+
required: true
110+
schema:
111+
type: string
112+
format: uuid
113+
responses:
114+
"200":
115+
description: The image binary data
116+
content:
117+
"*/*":
118+
schema:
119+
type: string
120+
format: binary
121+
default:
122+
$ref: ../responses/default_error.yaml
123+
100124
video:
101125
download:
102126
get:

0 commit comments

Comments
 (0)