Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-24113269342.0 KB
Electronic signature

Attach signature on annotation

Attach signature from interview to previously uploaded PDF contracts at all places annotated with text from request, with desired height on pdf. Annotations must contain text with either preselected values, or alternative can be supplied. If user wishes to use signature supplied during onboarding, DEFAULT signature type should be used.

Preselected values are: DEFAULT, INITIALS, PATIENTS_SIGNATURE, NON_MEDICAL_SIGNATURE_1, NON_MEDICAL_SIGNATURE_2, MEDICAL_SIGNATURE_1, MEDICAL_SIGNATURE_2

Endpoint is intended to be used as fluent api. One call to the api gives in responses id of the signed document which can then be used in the subsequent call to continuously add another signature on a different annotation.

post/omni/attach-signature-on-annotation

Query parameters

interviewIdstring

Headers

api-versionstring required

Request body

contractIdstring required

IDs of previously added contract (ID is returned on /add/document?imageType=contract)

signedContractIdstring

IDs of previously signed contract (ID is returned as response from the previous /attach/signature/on/annotation)

signatureType'DEFAULT' | 'INITIALS' | 'PATIENTS_SIGNATURE' | 'NON_MEDICAL_SIGNATURE_1' | 'NON_MEDICAL_SIGNATURE_2' | 'MEDICAL_SIGNATURE_1' | 'MEDICAL_SIGNATURE_2' | 'MEDICAL_SIGNATURE_3' | 'PATIENTS_SIGNATURE_NAME' | 'NON_MEDICAL_SIGNATURE_1_NAME' | 'NON_MEDICAL_SIGNATURE_2_NAME' | 'MEDICAL_SIGNATURE_1_NAME' | 'MEDICAL_SIGNATURE_2_NAME'

One of the preselected values for annotation text

alternativeSignatureTypestring

If annotation text is none of the preselected values, pass in here the alternative value (signature must be inserted with the alternative value into database as it's signature type)

Example request

{
  "contractId": "e81cd044-98fd-47b0-b0c5-937b22b69977#contract1",
  "signatureType": "PATIENTS_SIGNATURE"
}

Response

OK

successboolean

Flag indicating request passed successfully.

sessionStatus'Alive' | 'Closed' | 'Deleted'

Session status

additionalInformationobject