POST /apps/gov-es/v1/entry/{silo_entry_id}/{system}/identity

Upload an image of an identity document.

Request

Base URL
https://api.invopop.com
Auth
none required
TypeScript
https://skmtc.dev/invopop/apis/access-service-api/docs/apps/gov-es/v1/entry/:silo_entry_id/:system/identity/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

silo_entry_idstring required

ID of the org.Party silo entry to upload the identity for.

Example:5b45453c-cdd0-11ed-afa1-0242ac120002

system'sii' required

System in which the party is being registered.

Request body

datastring byte required

Base64 encoded binary data of the image. Must be of type image/jpeg or image/png, with a maximum file size of 10MB. The text of the image should be clearly visible to be approved.

view'front' | 'back' | 'page' required

Point of view from which the image is taken. Pick one of the options available:

front - Front view of the identity card.
back - Rear or back view of the identity card.
page - Principal identity page of the document.

Response

No content

Changes

No recorded changes to this operation across all 1 revision of this API.