dmss-container-and-signature-services (1.4.2)
Download OpenAPI specification:Download
signPDFSmartId
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string |
idCode | string |
country | string |
displayText | string |
displayTextLong | string |
role | string |
documentNumber | string |
delay | integer <int32> |
callbackUrl | string |
hashToSign | string |
signatureLocation | string |
signatureReason | string |
signatureContactInfo | string |
certInHex | string |
pdfSignatureIsVisible | boolean |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signatureProfile | string |
signingInfo | object |
forcePin | boolean |
font | string |
signerTextVerticalPosition | string |
signatureImageScaling | string |
Responses
Request samples
- Payload
{- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string",
- "signatureLocation": "string",
- "signatureReason": "string",
- "signatureContactInfo": "string",
- "certInHex": "string",
- "pdfSignatureIsVisible": true,
- "pdfSignatureVisuals": {
- "signatureImage": "string",
- "signatureText": "string",
- "signatureXAxis": 0,
- "signatureYAxis": 0,
- "signatureZoom": 0,
- "signaturePage": 0,
- "sigMod2XIndent": 0,
- "sigMod2YIndent": 0,
- "signatureFieldHeight": 0,
- "signatureFieldWidth": 0
}, - "pdfAdditionalText": {
- "text": "string",
- "x": 0,
- "y": 0,
- "font": "string",
- "fontSize": 0,
- "page": 0,
- "colour": {
- "r": 0,
- "g": 0,
- "b": 0
}, - "transparency": 0.1
}, - "label": "string",
- "signatureProfile": "string",
- "signingInfo": { },
- "forcePin": true,
- "font": "string",
- "signerTextVerticalPosition": "string",
- "signatureImageScaling": "string"
}
startPDFSign
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string |
idCode | string |
country | string |
displayText | string |
displayTextLong | string |
role | string |
documentNumber | string |
delay | integer <int32> |
callbackUrl | string |
hashToSign | string |
signatureReason | string |
signatureContactInfo | string |
label | string |
signatureProfile | string |
pdfSignatureIsVisible | boolean |
Responses
Request samples
- Payload
{- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string",
- "signatureReason": "string",
- "signatureContactInfo": "string",
- "label": "string",
- "signatureProfile": "string",
- "pdfSignatureIsVisible": true
}
startDocumentSign
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string |
idCode | string |
country | string |
displayText | string |
displayTextLong | string |
role | string |
documentNumber | string |
delay | integer <int32> |
callbackUrl | string |
hashToSign | string |
signatureReason | string |
signatureContactInfo | string |
label | string |
signatureProfile | string |
pdfSignatureIsVisible | boolean |
Responses
Request samples
- Payload
{- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string",
- "signatureReason": "string",
- "signatureContactInfo": "string",
- "label": "string",
- "signatureProfile": "string",
- "pdfSignatureIsVisible": true
}
startContainerSign
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string |
idCode | string |
country | string |
displayText | string |
displayTextLong | string |
role | string |
documentNumber | string |
delay | integer <int32> |
callbackUrl | string |
hashToSign | string |
signatureLocation | string |
signatureReason | string |
signatureContactInfo | string |
certInHex | string |
pdfSignatureIsVisible | boolean |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signatureProfile | string |
signingInfo | object |
forcePin | boolean |
font | string |
signerTextVerticalPosition | string |
signatureImageScaling | string |
Responses
Request samples
- Payload
{- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string",
- "signatureLocation": "string",
- "signatureReason": "string",
- "signatureContactInfo": "string",
- "certInHex": "string",
- "pdfSignatureIsVisible": true,
- "pdfSignatureVisuals": {
- "signatureImage": "string",
- "signatureText": "string",
- "signatureXAxis": 0,
- "signatureYAxis": 0,
- "signatureZoom": 0,
- "signaturePage": 0,
- "sigMod2XIndent": 0,
- "sigMod2YIndent": 0,
- "signatureFieldHeight": 0,
- "signatureFieldWidth": 0
}, - "pdfAdditionalText": {
- "text": "string",
- "x": 0,
- "y": 0,
- "font": "string",
- "fontSize": 0,
- "page": 0,
- "colour": {
- "r": 0,
- "g": 0,
- "b": 0
}, - "transparency": 0.1
}, - "label": "string",
- "signatureProfile": "string",
- "signingInfo": { },
- "forcePin": true,
- "font": "string",
- "signerTextVerticalPosition": "string",
- "signatureImageScaling": "string"
}
signPDF
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string |
idCode | string |
country | string |
displayText | string |
displayTextLong | string |
role | string |
documentNumber | string |
delay | integer <int32> |
callbackUrl | string |
hashToSign | string |
signatureLocation | string |
signatureReason | string |
signatureContactInfo | string |
certInHex | string |
pdfSignatureIsVisible | boolean |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signatureProfile | string |
signingInfo | object |
forcePin | boolean |
font | string |
signerTextVerticalPosition | string |
signatureImageScaling | string |
Responses
Request samples
- Payload
{- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string",
- "signatureLocation": "string",
- "signatureReason": "string",
- "signatureContactInfo": "string",
- "certInHex": "string",
- "pdfSignatureIsVisible": true,
- "pdfSignatureVisuals": {
- "signatureImage": "string",
- "signatureText": "string",
- "signatureXAxis": 0,
- "signatureYAxis": 0,
- "signatureZoom": 0,
- "signaturePage": 0,
- "sigMod2XIndent": 0,
- "sigMod2YIndent": 0,
- "signatureFieldHeight": 0,
- "signatureFieldWidth": 0
}, - "pdfAdditionalText": {
- "text": "string",
- "x": 0,
- "y": 0,
- "font": "string",
- "fontSize": 0,
- "page": 0,
- "colour": {
- "r": 0,
- "g": 0,
- "b": 0
}, - "transparency": 0.1
}, - "label": "string",
- "signatureProfile": "string",
- "signingInfo": { },
- "forcePin": true,
- "font": "string",
- "signerTextVerticalPosition": "string",
- "signatureImageScaling": "string"
}
signDocument
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string |
idCode | string |
country | string |
displayText | string |
displayTextLong | string |
role | string |
documentNumber | string |
delay | integer <int32> |
callbackUrl | string |
hashToSign | string |
signatureLocation | string |
signatureReason | string |
signatureContactInfo | string |
certInHex | string |
pdfSignatureIsVisible | boolean |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signatureProfile | string |
signingInfo | object |
forcePin | boolean |
font | string |
signerTextVerticalPosition | string |
signatureImageScaling | string |
Responses
Request samples
- Payload
{- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string",
- "signatureLocation": "string",
- "signatureReason": "string",
- "signatureContactInfo": "string",
- "certInHex": "string",
- "pdfSignatureIsVisible": true,
- "pdfSignatureVisuals": {
- "signatureImage": "string",
- "signatureText": "string",
- "signatureXAxis": 0,
- "signatureYAxis": 0,
- "signatureZoom": 0,
- "signaturePage": 0,
- "sigMod2XIndent": 0,
- "sigMod2YIndent": 0,
- "signatureFieldHeight": 0,
- "signatureFieldWidth": 0
}, - "pdfAdditionalText": {
- "text": "string",
- "x": 0,
- "y": 0,
- "font": "string",
- "fontSize": 0,
- "page": 0,
- "colour": {
- "r": 0,
- "g": 0,
- "b": 0
}, - "transparency": 0.1
}, - "label": "string",
- "signatureProfile": "string",
- "signingInfo": { },
- "forcePin": true,
- "font": "string",
- "signerTextVerticalPosition": "string",
- "signatureImageScaling": "string"
}
signDocument_1
Request Body schema: application/jsonrequired
phoneNo | string |
idCode | string |
country | string |
displayText | string |
displayTextLong | string |
role | string |
documentNumber | string |
delay | integer <int32> |
callbackUrl | string |
hashToSign | string |
Responses
Request samples
- Payload
{- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string"
}
Sign ASICE container.
Sign ASICE container with Smart-ID
path Parameters
id required | string |
signatureprofile required | string |
Request Body schema: application/jsonrequired
phoneNo | string |
idCode | string |
country | string |
displayText | string |
displayTextLong | string |
role | string |
documentNumber | string |
delay | integer <int32> |
callbackUrl | string |
hashToSign | string |
Responses
Request samples
- Payload
{- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string"
}
Response samples
- 200
{- "result": "string",
- "certInfo": {
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z"
}, - "callBackUrl": "string",
- "documentID": "string",
- "signRequest": {
- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string"
}, - "httpHeaders": {
- "empty": true,
- "host": {
- "address": {
- "canonicalHostName": "string",
- "hostAddress": "string",
- "address": [
- "string"
], - "hostName": "string",
- "linkLocalAddress": true,
- "multicastAddress": true,
- "anyLocalAddress": true,
- "loopbackAddress": true,
- "siteLocalAddress": true,
- "mcglobal": true,
- "mcnodeLocal": true,
- "mclinkLocal": true,
- "mcsiteLocal": true,
- "mcorgLocal": true
}, - "port": 0,
- "unresolved": true,
- "hostName": "string",
- "hostString": "string"
}, - "lastModified": 0,
- "contentLength": 0,
- "date": 0,
- "accept": [
- {
- "type": "string",
- "subtype": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "qualityValue": 0.1,
- "charset": "string",
- "subtypeSuffix": "string",
- "concrete": true,
- "wildcardType": true,
- "wildcardSubtype": true
}
], - "acceptLanguage": [
- {
- "range": "string",
- "weight": 0.1
}
], - "acceptLanguageAsLocales": [
- {
- "language": "string",
- "displayName": "string",
- "script": "string",
- "country": "string",
- "variant": "string",
- "extensionKeys": [
- "string"
], - "unicodeLocaleAttributes": [
- "string"
], - "unicodeLocaleKeys": [
- "string"
], - "iso3Language": "string",
- "iso3Country": "string",
- "displayLanguage": "string",
- "displayScript": "string",
- "displayCountry": "string",
- "displayVariant": "string"
}
], - "acceptPatch": [
- {
- "type": "string",
- "subtype": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "qualityValue": 0.1,
- "charset": "string",
- "subtypeSuffix": "string",
- "concrete": true,
- "wildcardType": true,
- "wildcardSubtype": true
}
], - "accessControlAllowCredentials": true,
- "accessControlAllowHeaders": [
- "string"
], - "accessControlAllowMethods": [
- "GET"
], - "accessControlAllowOrigin": "string",
- "accessControlExposeHeaders": [
- "string"
], - "accessControlMaxAge": 0,
- "accessControlRequestHeaders": [
- "string"
], - "accessControlRequestMethod": "GET",
- "acceptCharset": [
- "string"
], - "connection": [
- "string"
], - "contentLanguage": {
- "language": "string",
- "displayName": "string",
- "script": "string",
- "country": "string",
- "variant": "string",
- "extensionKeys": [
- "string"
], - "unicodeLocaleAttributes": [
- "string"
], - "unicodeLocaleKeys": [
- "string"
], - "iso3Language": "string",
- "iso3Country": "string",
- "displayLanguage": "string",
- "displayScript": "string",
- "displayCountry": "string",
- "displayVariant": "string"
}, - "etag": "string",
- "expires": 0,
- "ifMatch": [
- "string"
], - "ifNoneMatch": [
- "string"
], - "ifUnmodifiedSince": 0,
- "origin": "string",
- "pragma": "string",
- "range": [
- { }
], - "upgrade": "string",
- "vary": [
- "string"
], - "contentDisposition": {
- "type": "string",
- "name": "string",
- "filename": "string",
- "charset": "string",
- "size": 0,
- "creationDate": "2019-08-24T14:15:22Z",
- "modificationDate": "2019-08-24T14:15:22Z",
- "readDate": "2019-08-24T14:15:22Z",
- "attachment": true,
- "formData": true,
- "inline": true
}, - "allow": [
- "GET"
], - "cacheControl": "string",
- "contentType": {
- "type": "string",
- "subtype": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "qualityValue": 0.1,
- "charset": "string",
- "subtypeSuffix": "string",
- "concrete": true,
- "wildcardType": true,
- "wildcardSubtype": true
}, - "ifModifiedSince": 0,
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "signature": "string",
- "errorMessage": "string",
- "sessionCode": "string",
- "verificationCode": "string"
}
Sign ASICE container.
Sign ASICE container with Smart-ID
path Parameters
id required | string |
signatureprofile required | string |
Request Body schema: application/jsonrequired
phoneNo | string |
idCode | string |
country | string |
displayText | string |
displayTextLong | string |
role | string |
documentNumber | string |
delay | integer <int32> |
callbackUrl | string |
hashToSign | string |
Responses
Request samples
- Payload
{- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string"
}
Response samples
- 200
{- "result": "string",
- "certInfo": {
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z"
}, - "callBackUrl": "string",
- "documentID": "string",
- "signRequest": {
- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string"
}, - "httpHeaders": {
- "empty": true,
- "host": {
- "address": {
- "canonicalHostName": "string",
- "hostAddress": "string",
- "address": [
- "string"
], - "hostName": "string",
- "linkLocalAddress": true,
- "multicastAddress": true,
- "anyLocalAddress": true,
- "loopbackAddress": true,
- "siteLocalAddress": true,
- "mcglobal": true,
- "mcnodeLocal": true,
- "mclinkLocal": true,
- "mcsiteLocal": true,
- "mcorgLocal": true
}, - "port": 0,
- "unresolved": true,
- "hostName": "string",
- "hostString": "string"
}, - "lastModified": 0,
- "contentLength": 0,
- "date": 0,
- "accept": [
- {
- "type": "string",
- "subtype": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "qualityValue": 0.1,
- "charset": "string",
- "subtypeSuffix": "string",
- "concrete": true,
- "wildcardType": true,
- "wildcardSubtype": true
}
], - "acceptLanguage": [
- {
- "range": "string",
- "weight": 0.1
}
], - "acceptLanguageAsLocales": [
- {
- "language": "string",
- "displayName": "string",
- "script": "string",
- "country": "string",
- "variant": "string",
- "extensionKeys": [
- "string"
], - "unicodeLocaleAttributes": [
- "string"
], - "unicodeLocaleKeys": [
- "string"
], - "iso3Language": "string",
- "iso3Country": "string",
- "displayLanguage": "string",
- "displayScript": "string",
- "displayCountry": "string",
- "displayVariant": "string"
}
], - "acceptPatch": [
- {
- "type": "string",
- "subtype": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "qualityValue": 0.1,
- "charset": "string",
- "subtypeSuffix": "string",
- "concrete": true,
- "wildcardType": true,
- "wildcardSubtype": true
}
], - "accessControlAllowCredentials": true,
- "accessControlAllowHeaders": [
- "string"
], - "accessControlAllowMethods": [
- "GET"
], - "accessControlAllowOrigin": "string",
- "accessControlExposeHeaders": [
- "string"
], - "accessControlMaxAge": 0,
- "accessControlRequestHeaders": [
- "string"
], - "accessControlRequestMethod": "GET",
- "acceptCharset": [
- "string"
], - "connection": [
- "string"
], - "contentLanguage": {
- "language": "string",
- "displayName": "string",
- "script": "string",
- "country": "string",
- "variant": "string",
- "extensionKeys": [
- "string"
], - "unicodeLocaleAttributes": [
- "string"
], - "unicodeLocaleKeys": [
- "string"
], - "iso3Language": "string",
- "iso3Country": "string",
- "displayLanguage": "string",
- "displayScript": "string",
- "displayCountry": "string",
- "displayVariant": "string"
}, - "etag": "string",
- "expires": 0,
- "ifMatch": [
- "string"
], - "ifNoneMatch": [
- "string"
], - "ifUnmodifiedSince": 0,
- "origin": "string",
- "pragma": "string",
- "range": [
- { }
], - "upgrade": "string",
- "vary": [
- "string"
], - "contentDisposition": {
- "type": "string",
- "name": "string",
- "filename": "string",
- "charset": "string",
- "size": 0,
- "creationDate": "2019-08-24T14:15:22Z",
- "modificationDate": "2019-08-24T14:15:22Z",
- "readDate": "2019-08-24T14:15:22Z",
- "attachment": true,
- "formData": true,
- "inline": true
}, - "allow": [
- "GET"
], - "cacheControl": "string",
- "contentType": {
- "type": "string",
- "subtype": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "qualityValue": 0.1,
- "charset": "string",
- "subtypeSuffix": "string",
- "concrete": true,
- "wildcardType": true,
- "wildcardSubtype": true
}, - "ifModifiedSince": 0,
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "signature": "string",
- "errorMessage": "string",
- "sessionCode": "string",
- "verificationCode": "string"
}
signPDF_1
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string |
idCode | string |
country | string |
displayText | string |
displayTextLong | string |
role | string |
documentNumber | string |
delay | integer <int32> |
callbackUrl | string |
hashToSign | string |
signatureLocation | string |
signatureReason | string |
signatureContactInfo | string |
certInHex | string |
pdfSignatureIsVisible | boolean |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signatureProfile | string |
signingInfo | object |
forcePin | boolean |
font | string |
signerTextVerticalPosition | string |
signatureImageScaling | string |
Responses
Request samples
- Payload
{- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string",
- "signatureLocation": "string",
- "signatureReason": "string",
- "signatureContactInfo": "string",
- "certInHex": "string",
- "pdfSignatureIsVisible": true,
- "pdfSignatureVisuals": {
- "signatureImage": "string",
- "signatureText": "string",
- "signatureXAxis": 0,
- "signatureYAxis": 0,
- "signatureZoom": 0,
- "signaturePage": 0,
- "sigMod2XIndent": 0,
- "sigMod2YIndent": 0,
- "signatureFieldHeight": 0,
- "signatureFieldWidth": 0
}, - "pdfAdditionalText": {
- "text": "string",
- "x": 0,
- "y": 0,
- "font": "string",
- "fontSize": 0,
- "page": 0,
- "colour": {
- "r": 0,
- "g": 0,
- "b": 0
}, - "transparency": 0.1
}, - "label": "string",
- "signatureProfile": "string",
- "signingInfo": { },
- "forcePin": true,
- "font": "string",
- "signerTextVerticalPosition": "string",
- "signatureImageScaling": "string"
}
signDocument_2
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string |
idCode | string |
country | string |
displayText | string |
displayTextLong | string |
role | string |
documentNumber | string |
delay | integer <int32> |
callbackUrl | string |
hashToSign | string |
signatureLocation | string |
signatureReason | string |
signatureContactInfo | string |
certInHex | string |
pdfSignatureIsVisible | boolean |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signatureProfile | string |
signingInfo | object |
forcePin | boolean |
font | string |
signerTextVerticalPosition | string |
signatureImageScaling | string |
Responses
Request samples
- Payload
{- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string",
- "signatureLocation": "string",
- "signatureReason": "string",
- "signatureContactInfo": "string",
- "certInHex": "string",
- "pdfSignatureIsVisible": true,
- "pdfSignatureVisuals": {
- "signatureImage": "string",
- "signatureText": "string",
- "signatureXAxis": 0,
- "signatureYAxis": 0,
- "signatureZoom": 0,
- "signaturePage": 0,
- "sigMod2XIndent": 0,
- "sigMod2YIndent": 0,
- "signatureFieldHeight": 0,
- "signatureFieldWidth": 0
}, - "pdfAdditionalText": {
- "text": "string",
- "x": 0,
- "y": 0,
- "font": "string",
- "fontSize": 0,
- "page": 0,
- "colour": {
- "r": 0,
- "g": 0,
- "b": 0
}, - "transparency": 0.1
}, - "label": "string",
- "signatureProfile": "string",
- "signingInfo": { },
- "forcePin": true,
- "font": "string",
- "signerTextVerticalPosition": "string",
- "signatureImageScaling": "string"
}
signMobileIdContainer
Request Body schema: application/jsonrequired
phoneNo | string |
idCode | string |
country | string |
displayText | string |
displayTextLong | string |
role | string |
documentNumber | string |
delay | integer <int32> |
callbackUrl | string |
hashToSign | string |
Responses
Request samples
- Payload
{- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string"
}
signMobileIdContainer_1
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string |
idCode | string |
country | string |
displayText | string |
displayTextLong | string |
role | string |
documentNumber | string |
delay | integer <int32> |
callbackUrl | string |
hashToSign | string |
signatureLocation | string |
signatureReason | string |
signatureContactInfo | string |
certInHex | string |
pdfSignatureIsVisible | boolean |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signatureProfile | string |
signingInfo | object |
forcePin | boolean |
font | string |
signerTextVerticalPosition | string |
signatureImageScaling | string |
Responses
Request samples
- Payload
{- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string",
- "signatureLocation": "string",
- "signatureReason": "string",
- "signatureContactInfo": "string",
- "certInHex": "string",
- "pdfSignatureIsVisible": true,
- "pdfSignatureVisuals": {
- "signatureImage": "string",
- "signatureText": "string",
- "signatureXAxis": 0,
- "signatureYAxis": 0,
- "signatureZoom": 0,
- "signaturePage": 0,
- "sigMod2XIndent": 0,
- "sigMod2YIndent": 0,
- "signatureFieldHeight": 0,
- "signatureFieldWidth": 0
}, - "pdfAdditionalText": {
- "text": "string",
- "x": 0,
- "y": 0,
- "font": "string",
- "fontSize": 0,
- "page": 0,
- "colour": {
- "r": 0,
- "g": 0,
- "b": 0
}, - "transparency": 0.1
}, - "label": "string",
- "signatureProfile": "string",
- "signingInfo": { },
- "forcePin": true,
- "font": "string",
- "signerTextVerticalPosition": "string",
- "signatureImageScaling": "string"
}
signPDF_2
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string |
idCode | string |
country | string |
displayText | string |
displayTextLong | string |
role | string |
documentNumber | string |
delay | integer <int32> |
callbackUrl | string |
hashToSign | string |
signatureLocation | string |
signatureReason | string |
signatureContactInfo | string |
certInHex | string |
pdfSignatureIsVisible | boolean |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signatureProfile | string |
signingInfo | object |
forcePin | boolean |
font | string |
signerTextVerticalPosition | string |
signatureImageScaling | string |
Responses
Request samples
- Payload
{- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string",
- "signatureLocation": "string",
- "signatureReason": "string",
- "signatureContactInfo": "string",
- "certInHex": "string",
- "pdfSignatureIsVisible": true,
- "pdfSignatureVisuals": {
- "signatureImage": "string",
- "signatureText": "string",
- "signatureXAxis": 0,
- "signatureYAxis": 0,
- "signatureZoom": 0,
- "signaturePage": 0,
- "sigMod2XIndent": 0,
- "sigMod2YIndent": 0,
- "signatureFieldHeight": 0,
- "signatureFieldWidth": 0
}, - "pdfAdditionalText": {
- "text": "string",
- "x": 0,
- "y": 0,
- "font": "string",
- "fontSize": 0,
- "page": 0,
- "colour": {
- "r": 0,
- "g": 0,
- "b": 0
}, - "transparency": 0.1
}, - "label": "string",
- "signatureProfile": "string",
- "signingInfo": { },
- "forcePin": true,
- "font": "string",
- "signerTextVerticalPosition": "string",
- "signatureImageScaling": "string"
}
signDocument_3
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string |
idCode | string |
country | string |
displayText | string |
displayTextLong | string |
role | string |
documentNumber | string |
delay | integer <int32> |
callbackUrl | string |
hashToSign | string |
signatureLocation | string |
signatureReason | string |
signatureContactInfo | string |
certInHex | string |
pdfSignatureIsVisible | boolean |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signatureProfile | string |
signingInfo | object |
forcePin | boolean |
font | string |
signerTextVerticalPosition | string |
signatureImageScaling | string |
Responses
Request samples
- Payload
{- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string",
- "signatureLocation": "string",
- "signatureReason": "string",
- "signatureContactInfo": "string",
- "certInHex": "string",
- "pdfSignatureIsVisible": true,
- "pdfSignatureVisuals": {
- "signatureImage": "string",
- "signatureText": "string",
- "signatureXAxis": 0,
- "signatureYAxis": 0,
- "signatureZoom": 0,
- "signaturePage": 0,
- "sigMod2XIndent": 0,
- "sigMod2YIndent": 0,
- "signatureFieldHeight": 0,
- "signatureFieldWidth": 0
}, - "pdfAdditionalText": {
- "text": "string",
- "x": 0,
- "y": 0,
- "font": "string",
- "fontSize": 0,
- "page": 0,
- "colour": {
- "r": 0,
- "g": 0,
- "b": 0
}, - "transparency": 0.1
}, - "label": "string",
- "signatureProfile": "string",
- "signingInfo": { },
- "forcePin": true,
- "font": "string",
- "signerTextVerticalPosition": "string",
- "signatureImageScaling": "string"
}
Sign ASICE container.
Sign ASICE container with Smart-ID
path Parameters
id required | string |
signatureprofile required | string |
Request Body schema: application/jsonrequired
idCode required | string Example: "390101-00001" Person personal code |
displayText | string Example: "Please sign document" Message displayed to the user to prompt them to authorize. Up to 300 characters of text. |
forcePin | boolean Example: "false" Request to use PIN code, biometrics not allowed. |
Responses
Request samples
- Payload
{- "displayText": "Please sign document",
- "forcePin": false,
- "idCode": "390101-00001"
}
Response samples
- 200
{- "result": "string",
- "certInfo": {
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z"
}, - "callBackUrl": "string",
- "documentID": "string",
- "signRequest": {
- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string"
}, - "httpHeaders": {
- "empty": true,
- "host": {
- "address": {
- "canonicalHostName": "string",
- "hostAddress": "string",
- "address": [
- "string"
], - "hostName": "string",
- "linkLocalAddress": true,
- "multicastAddress": true,
- "anyLocalAddress": true,
- "loopbackAddress": true,
- "siteLocalAddress": true,
- "mcglobal": true,
- "mcnodeLocal": true,
- "mclinkLocal": true,
- "mcsiteLocal": true,
- "mcorgLocal": true
}, - "port": 0,
- "unresolved": true,
- "hostName": "string",
- "hostString": "string"
}, - "lastModified": 0,
- "contentLength": 0,
- "date": 0,
- "accept": [
- {
- "type": "string",
- "subtype": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "qualityValue": 0.1,
- "charset": "string",
- "subtypeSuffix": "string",
- "concrete": true,
- "wildcardType": true,
- "wildcardSubtype": true
}
], - "acceptLanguage": [
- {
- "range": "string",
- "weight": 0.1
}
], - "acceptLanguageAsLocales": [
- {
- "language": "string",
- "displayName": "string",
- "script": "string",
- "country": "string",
- "variant": "string",
- "extensionKeys": [
- "string"
], - "unicodeLocaleAttributes": [
- "string"
], - "unicodeLocaleKeys": [
- "string"
], - "iso3Language": "string",
- "iso3Country": "string",
- "displayLanguage": "string",
- "displayScript": "string",
- "displayCountry": "string",
- "displayVariant": "string"
}
], - "acceptPatch": [
- {
- "type": "string",
- "subtype": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "qualityValue": 0.1,
- "charset": "string",
- "subtypeSuffix": "string",
- "concrete": true,
- "wildcardType": true,
- "wildcardSubtype": true
}
], - "accessControlAllowCredentials": true,
- "accessControlAllowHeaders": [
- "string"
], - "accessControlAllowMethods": [
- "GET"
], - "accessControlAllowOrigin": "string",
- "accessControlExposeHeaders": [
- "string"
], - "accessControlMaxAge": 0,
- "accessControlRequestHeaders": [
- "string"
], - "accessControlRequestMethod": "GET",
- "acceptCharset": [
- "string"
], - "connection": [
- "string"
], - "contentLanguage": {
- "language": "string",
- "displayName": "string",
- "script": "string",
- "country": "string",
- "variant": "string",
- "extensionKeys": [
- "string"
], - "unicodeLocaleAttributes": [
- "string"
], - "unicodeLocaleKeys": [
- "string"
], - "iso3Language": "string",
- "iso3Country": "string",
- "displayLanguage": "string",
- "displayScript": "string",
- "displayCountry": "string",
- "displayVariant": "string"
}, - "etag": "string",
- "expires": 0,
- "ifMatch": [
- "string"
], - "ifNoneMatch": [
- "string"
], - "ifUnmodifiedSince": 0,
- "origin": "string",
- "pragma": "string",
- "range": [
- { }
], - "upgrade": "string",
- "vary": [
- "string"
], - "contentDisposition": {
- "type": "string",
- "name": "string",
- "filename": "string",
- "charset": "string",
- "size": 0,
- "creationDate": "2019-08-24T14:15:22Z",
- "modificationDate": "2019-08-24T14:15:22Z",
- "readDate": "2019-08-24T14:15:22Z",
- "attachment": true,
- "formData": true,
- "inline": true
}, - "allow": [
- "GET"
], - "cacheControl": "string",
- "contentType": {
- "type": "string",
- "subtype": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "qualityValue": 0.1,
- "charset": "string",
- "subtypeSuffix": "string",
- "concrete": true,
- "wildcardType": true,
- "wildcardSubtype": true
}, - "ifModifiedSince": 0,
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "signature": "string",
- "errorMessage": "string",
- "sessionCode": "string",
- "verificationCode": "string"
}
Sign ASICE container.
Sign ASICE container with Smart-ID
path Parameters
id required | string |
signatureprofile required | string |
Request Body schema: application/jsonrequired
idCode required | string Example: "390101-00001" Person personal code |
displayText | string Example: "Please sign document" Message displayed to the user to prompt them to authorize. Up to 300 characters of text. |
forcePin | boolean Example: "false" Request to use PIN code, biometrics not allowed. |
Responses
Request samples
- Payload
{- "displayText": "Please sign document",
- "forcePin": false,
- "idCode": "390101-00001"
}
Response samples
- 200
{- "result": "string",
- "certInfo": {
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z"
}, - "callBackUrl": "string",
- "documentID": "string",
- "signRequest": {
- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string"
}, - "httpHeaders": {
- "empty": true,
- "host": {
- "address": {
- "canonicalHostName": "string",
- "hostAddress": "string",
- "address": [
- "string"
], - "hostName": "string",
- "linkLocalAddress": true,
- "multicastAddress": true,
- "anyLocalAddress": true,
- "loopbackAddress": true,
- "siteLocalAddress": true,
- "mcglobal": true,
- "mcnodeLocal": true,
- "mclinkLocal": true,
- "mcsiteLocal": true,
- "mcorgLocal": true
}, - "port": 0,
- "unresolved": true,
- "hostName": "string",
- "hostString": "string"
}, - "lastModified": 0,
- "contentLength": 0,
- "date": 0,
- "accept": [
- {
- "type": "string",
- "subtype": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "qualityValue": 0.1,
- "charset": "string",
- "subtypeSuffix": "string",
- "concrete": true,
- "wildcardType": true,
- "wildcardSubtype": true
}
], - "acceptLanguage": [
- {
- "range": "string",
- "weight": 0.1
}
], - "acceptLanguageAsLocales": [
- {
- "language": "string",
- "displayName": "string",
- "script": "string",
- "country": "string",
- "variant": "string",
- "extensionKeys": [
- "string"
], - "unicodeLocaleAttributes": [
- "string"
], - "unicodeLocaleKeys": [
- "string"
], - "iso3Language": "string",
- "iso3Country": "string",
- "displayLanguage": "string",
- "displayScript": "string",
- "displayCountry": "string",
- "displayVariant": "string"
}
], - "acceptPatch": [
- {
- "type": "string",
- "subtype": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "qualityValue": 0.1,
- "charset": "string",
- "subtypeSuffix": "string",
- "concrete": true,
- "wildcardType": true,
- "wildcardSubtype": true
}
], - "accessControlAllowCredentials": true,
- "accessControlAllowHeaders": [
- "string"
], - "accessControlAllowMethods": [
- "GET"
], - "accessControlAllowOrigin": "string",
- "accessControlExposeHeaders": [
- "string"
], - "accessControlMaxAge": 0,
- "accessControlRequestHeaders": [
- "string"
], - "accessControlRequestMethod": "GET",
- "acceptCharset": [
- "string"
], - "connection": [
- "string"
], - "contentLanguage": {
- "language": "string",
- "displayName": "string",
- "script": "string",
- "country": "string",
- "variant": "string",
- "extensionKeys": [
- "string"
], - "unicodeLocaleAttributes": [
- "string"
], - "unicodeLocaleKeys": [
- "string"
], - "iso3Language": "string",
- "iso3Country": "string",
- "displayLanguage": "string",
- "displayScript": "string",
- "displayCountry": "string",
- "displayVariant": "string"
}, - "etag": "string",
- "expires": 0,
- "ifMatch": [
- "string"
], - "ifNoneMatch": [
- "string"
], - "ifUnmodifiedSince": 0,
- "origin": "string",
- "pragma": "string",
- "range": [
- { }
], - "upgrade": "string",
- "vary": [
- "string"
], - "contentDisposition": {
- "type": "string",
- "name": "string",
- "filename": "string",
- "charset": "string",
- "size": 0,
- "creationDate": "2019-08-24T14:15:22Z",
- "modificationDate": "2019-08-24T14:15:22Z",
- "readDate": "2019-08-24T14:15:22Z",
- "attachment": true,
- "formData": true,
- "inline": true
}, - "allow": [
- "GET"
], - "cacheControl": "string",
- "contentType": {
- "type": "string",
- "subtype": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "qualityValue": 0.1,
- "charset": "string",
- "subtypeSuffix": "string",
- "concrete": true,
- "wildcardType": true,
- "wildcardSubtype": true
}, - "ifModifiedSince": 0,
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "signature": "string",
- "errorMessage": "string",
- "sessionCode": "string",
- "verificationCode": "string"
}
E-Seal pdf document
E-Seal pdf document in archive referenced by id from request. For visual signature specify 'pdfSigningSigner' parameter value according to pdfSigningSigner schema.
path Parameters
id required | string |
company required | string |
query Parameters
pdfSigningSigner | string |
Responses
Response samples
- 200
{- "result": "string",
- "certInfo": {
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z"
}, - "callBackUrl": "string",
- "documentID": "string",
- "signRequest": {
- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string"
}, - "httpHeaders": {
- "empty": true,
- "host": {
- "address": {
- "canonicalHostName": "string",
- "hostAddress": "string",
- "address": [
- "string"
], - "hostName": "string",
- "linkLocalAddress": true,
- "multicastAddress": true,
- "anyLocalAddress": true,
- "loopbackAddress": true,
- "siteLocalAddress": true,
- "mcglobal": true,
- "mcnodeLocal": true,
- "mclinkLocal": true,
- "mcsiteLocal": true,
- "mcorgLocal": true
}, - "port": 0,
- "unresolved": true,
- "hostName": "string",
- "hostString": "string"
}, - "lastModified": 0,
- "contentLength": 0,
- "date": 0,
- "accept": [
- {
- "type": "string",
- "subtype": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "qualityValue": 0.1,
- "charset": "string",
- "subtypeSuffix": "string",
- "concrete": true,
- "wildcardType": true,
- "wildcardSubtype": true
}
], - "acceptLanguage": [
- {
- "range": "string",
- "weight": 0.1
}
], - "acceptLanguageAsLocales": [
- {
- "language": "string",
- "displayName": "string",
- "script": "string",
- "country": "string",
- "variant": "string",
- "extensionKeys": [
- "string"
], - "unicodeLocaleAttributes": [
- "string"
], - "unicodeLocaleKeys": [
- "string"
], - "iso3Language": "string",
- "iso3Country": "string",
- "displayLanguage": "string",
- "displayScript": "string",
- "displayCountry": "string",
- "displayVariant": "string"
}
], - "acceptPatch": [
- {
- "type": "string",
- "subtype": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "qualityValue": 0.1,
- "charset": "string",
- "subtypeSuffix": "string",
- "concrete": true,
- "wildcardType": true,
- "wildcardSubtype": true
}
], - "accessControlAllowCredentials": true,
- "accessControlAllowHeaders": [
- "string"
], - "accessControlAllowMethods": [
- "GET"
], - "accessControlAllowOrigin": "string",
- "accessControlExposeHeaders": [
- "string"
], - "accessControlMaxAge": 0,
- "accessControlRequestHeaders": [
- "string"
], - "accessControlRequestMethod": "GET",
- "acceptCharset": [
- "string"
], - "connection": [
- "string"
], - "contentLanguage": {
- "language": "string",
- "displayName": "string",
- "script": "string",
- "country": "string",
- "variant": "string",
- "extensionKeys": [
- "string"
], - "unicodeLocaleAttributes": [
- "string"
], - "unicodeLocaleKeys": [
- "string"
], - "iso3Language": "string",
- "iso3Country": "string",
- "displayLanguage": "string",
- "displayScript": "string",
- "displayCountry": "string",
- "displayVariant": "string"
}, - "etag": "string",
- "expires": 0,
- "ifMatch": [
- "string"
], - "ifNoneMatch": [
- "string"
], - "ifUnmodifiedSince": 0,
- "origin": "string",
- "pragma": "string",
- "range": [
- { }
], - "upgrade": "string",
- "vary": [
- "string"
], - "contentDisposition": {
- "type": "string",
- "name": "string",
- "filename": "string",
- "charset": "string",
- "size": 0,
- "creationDate": "2019-08-24T14:15:22Z",
- "modificationDate": "2019-08-24T14:15:22Z",
- "readDate": "2019-08-24T14:15:22Z",
- "attachment": true,
- "formData": true,
- "inline": true
}, - "allow": [
- "GET"
], - "cacheControl": "string",
- "contentType": {
- "type": "string",
- "subtype": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "qualityValue": 0.1,
- "charset": "string",
- "subtypeSuffix": "string",
- "concrete": true,
- "wildcardType": true,
- "wildcardSubtype": true
}, - "ifModifiedSince": 0,
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "signature": "string",
- "errorMessage": "string",
- "container": {
- "signatures": [
- {
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
]
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
]
}
}
E-Seal ASICE container.
E-Seal ASICE container created from file(s) provided by request.
path Parameters
company required | string |
query Parameters
fileName | Array of strings |
containerName | string |
signatureProfile | string |
Request Body schema: */*
file required | Array of strings <binary> [ items <binary > ] |
Responses
E-Seal ASIC document.
E-Seal asic container reference provided by request. If referenced document is not ASICE container, create one from document referenced
path Parameters
id required | string |
company required | string |
query Parameters
signatureProfile | string |
Request Body schema: application/json
phoneNo | string |
idCode | string |
country | string |
displayText | string |
displayTextLong | string |
role | string |
documentNumber | string |
delay | integer <int32> |
callbackUrl | string |
hashToSign | string |
signatureLocation | string |
signatureReason | string |
signatureContactInfo | string |
certInHex | string |
pdfSignatureIsVisible | boolean |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signatureProfile | string |
signingInfo | object |
forcePin | boolean |
font | string |
signerTextVerticalPosition | string |
signatureImageScaling | string |
Responses
Request samples
- Payload
{- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string",
- "signatureLocation": "string",
- "signatureReason": "string",
- "signatureContactInfo": "string",
- "certInHex": "string",
- "pdfSignatureIsVisible": true,
- "pdfSignatureVisuals": {
- "signatureImage": "string",
- "signatureText": "string",
- "signatureXAxis": 0,
- "signatureYAxis": 0,
- "signatureZoom": 0,
- "signaturePage": 0,
- "sigMod2XIndent": 0,
- "sigMod2YIndent": 0,
- "signatureFieldHeight": 0,
- "signatureFieldWidth": 0
}, - "pdfAdditionalText": {
- "text": "string",
- "x": 0,
- "y": 0,
- "font": "string",
- "fontSize": 0,
- "page": 0,
- "colour": {
- "r": 0,
- "g": 0,
- "b": 0
}, - "transparency": 0.1
}, - "label": "string",
- "signatureProfile": "string",
- "signingInfo": { },
- "forcePin": true,
- "font": "string",
- "signerTextVerticalPosition": "string",
- "signatureImageScaling": "string"
}
Response samples
- 200
{- "result": "string",
- "certInfo": {
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z"
}, - "callBackUrl": "string",
- "documentID": "string",
- "signRequest": {
- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string"
}, - "httpHeaders": {
- "empty": true,
- "host": {
- "address": {
- "canonicalHostName": "string",
- "hostAddress": "string",
- "address": [
- "string"
], - "hostName": "string",
- "linkLocalAddress": true,
- "multicastAddress": true,
- "anyLocalAddress": true,
- "loopbackAddress": true,
- "siteLocalAddress": true,
- "mcglobal": true,
- "mcnodeLocal": true,
- "mclinkLocal": true,
- "mcsiteLocal": true,
- "mcorgLocal": true
}, - "port": 0,
- "unresolved": true,
- "hostName": "string",
- "hostString": "string"
}, - "lastModified": 0,
- "contentLength": 0,
- "date": 0,
- "accept": [
- {
- "type": "string",
- "subtype": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "qualityValue": 0.1,
- "charset": "string",
- "subtypeSuffix": "string",
- "concrete": true,
- "wildcardType": true,
- "wildcardSubtype": true
}
], - "acceptLanguage": [
- {
- "range": "string",
- "weight": 0.1
}
], - "acceptLanguageAsLocales": [
- {
- "language": "string",
- "displayName": "string",
- "script": "string",
- "country": "string",
- "variant": "string",
- "extensionKeys": [
- "string"
], - "unicodeLocaleAttributes": [
- "string"
], - "unicodeLocaleKeys": [
- "string"
], - "iso3Language": "string",
- "iso3Country": "string",
- "displayLanguage": "string",
- "displayScript": "string",
- "displayCountry": "string",
- "displayVariant": "string"
}
], - "acceptPatch": [
- {
- "type": "string",
- "subtype": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "qualityValue": 0.1,
- "charset": "string",
- "subtypeSuffix": "string",
- "concrete": true,
- "wildcardType": true,
- "wildcardSubtype": true
}
], - "accessControlAllowCredentials": true,
- "accessControlAllowHeaders": [
- "string"
], - "accessControlAllowMethods": [
- "GET"
], - "accessControlAllowOrigin": "string",
- "accessControlExposeHeaders": [
- "string"
], - "accessControlMaxAge": 0,
- "accessControlRequestHeaders": [
- "string"
], - "accessControlRequestMethod": "GET",
- "acceptCharset": [
- "string"
], - "connection": [
- "string"
], - "contentLanguage": {
- "language": "string",
- "displayName": "string",
- "script": "string",
- "country": "string",
- "variant": "string",
- "extensionKeys": [
- "string"
], - "unicodeLocaleAttributes": [
- "string"
], - "unicodeLocaleKeys": [
- "string"
], - "iso3Language": "string",
- "iso3Country": "string",
- "displayLanguage": "string",
- "displayScript": "string",
- "displayCountry": "string",
- "displayVariant": "string"
}, - "etag": "string",
- "expires": 0,
- "ifMatch": [
- "string"
], - "ifNoneMatch": [
- "string"
], - "ifUnmodifiedSince": 0,
- "origin": "string",
- "pragma": "string",
- "range": [
- { }
], - "upgrade": "string",
- "vary": [
- "string"
], - "contentDisposition": {
- "type": "string",
- "name": "string",
- "filename": "string",
- "charset": "string",
- "size": 0,
- "creationDate": "2019-08-24T14:15:22Z",
- "modificationDate": "2019-08-24T14:15:22Z",
- "readDate": "2019-08-24T14:15:22Z",
- "attachment": true,
- "formData": true,
- "inline": true
}, - "allow": [
- "GET"
], - "cacheControl": "string",
- "contentType": {
- "type": "string",
- "subtype": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "qualityValue": 0.1,
- "charset": "string",
- "subtypeSuffix": "string",
- "concrete": true,
- "wildcardType": true,
- "wildcardSubtype": true
}, - "ifModifiedSince": 0,
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "signature": "string",
- "errorMessage": "string",
- "container": {
- "containerId": "string",
- "containerInfo": {
- "signatures": [
- {
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
]
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
]
}
}
}
E-Seal ASICE container.
E-Seal ASICE container reference provided by request.
path Parameters
id required | string |
company required | string |
query Parameters
signatureProfile | string |
Responses
Response samples
- 200
{- "result": "string",
- "certInfo": {
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z"
}, - "callBackUrl": "string",
- "documentID": "string",
- "signRequest": {
- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string"
}, - "httpHeaders": {
- "empty": true,
- "host": {
- "address": {
- "canonicalHostName": "string",
- "hostAddress": "string",
- "address": [
- "string"
], - "hostName": "string",
- "linkLocalAddress": true,
- "multicastAddress": true,
- "anyLocalAddress": true,
- "loopbackAddress": true,
- "siteLocalAddress": true,
- "mcglobal": true,
- "mcnodeLocal": true,
- "mclinkLocal": true,
- "mcsiteLocal": true,
- "mcorgLocal": true
}, - "port": 0,
- "unresolved": true,
- "hostName": "string",
- "hostString": "string"
}, - "lastModified": 0,
- "contentLength": 0,
- "date": 0,
- "accept": [
- {
- "type": "string",
- "subtype": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "qualityValue": 0.1,
- "charset": "string",
- "subtypeSuffix": "string",
- "concrete": true,
- "wildcardType": true,
- "wildcardSubtype": true
}
], - "acceptLanguage": [
- {
- "range": "string",
- "weight": 0.1
}
], - "acceptLanguageAsLocales": [
- {
- "language": "string",
- "displayName": "string",
- "script": "string",
- "country": "string",
- "variant": "string",
- "extensionKeys": [
- "string"
], - "unicodeLocaleAttributes": [
- "string"
], - "unicodeLocaleKeys": [
- "string"
], - "iso3Language": "string",
- "iso3Country": "string",
- "displayLanguage": "string",
- "displayScript": "string",
- "displayCountry": "string",
- "displayVariant": "string"
}
], - "acceptPatch": [
- {
- "type": "string",
- "subtype": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "qualityValue": 0.1,
- "charset": "string",
- "subtypeSuffix": "string",
- "concrete": true,
- "wildcardType": true,
- "wildcardSubtype": true
}
], - "accessControlAllowCredentials": true,
- "accessControlAllowHeaders": [
- "string"
], - "accessControlAllowMethods": [
- "GET"
], - "accessControlAllowOrigin": "string",
- "accessControlExposeHeaders": [
- "string"
], - "accessControlMaxAge": 0,
- "accessControlRequestHeaders": [
- "string"
], - "accessControlRequestMethod": "GET",
- "acceptCharset": [
- "string"
], - "connection": [
- "string"
], - "contentLanguage": {
- "language": "string",
- "displayName": "string",
- "script": "string",
- "country": "string",
- "variant": "string",
- "extensionKeys": [
- "string"
], - "unicodeLocaleAttributes": [
- "string"
], - "unicodeLocaleKeys": [
- "string"
], - "iso3Language": "string",
- "iso3Country": "string",
- "displayLanguage": "string",
- "displayScript": "string",
- "displayCountry": "string",
- "displayVariant": "string"
}, - "etag": "string",
- "expires": 0,
- "ifMatch": [
- "string"
], - "ifNoneMatch": [
- "string"
], - "ifUnmodifiedSince": 0,
- "origin": "string",
- "pragma": "string",
- "range": [
- { }
], - "upgrade": "string",
- "vary": [
- "string"
], - "contentDisposition": {
- "type": "string",
- "name": "string",
- "filename": "string",
- "charset": "string",
- "size": 0,
- "creationDate": "2019-08-24T14:15:22Z",
- "modificationDate": "2019-08-24T14:15:22Z",
- "readDate": "2019-08-24T14:15:22Z",
- "attachment": true,
- "formData": true,
- "inline": true
}, - "allow": [
- "GET"
], - "cacheControl": "string",
- "contentType": {
- "type": "string",
- "subtype": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "qualityValue": 0.1,
- "charset": "string",
- "subtypeSuffix": "string",
- "concrete": true,
- "wildcardType": true,
- "wildcardSubtype": true
}, - "ifModifiedSince": 0,
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "signature": "string",
- "errorMessage": "string",
- "container": {
- "containerId": "string",
- "containerInfo": {
- "signatures": [
- {
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
]
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
]
}
}
}
getAuthenticationResult
path Parameters
provider required | string |
query Parameters
state required | string |
code required | string |
Responses
Response samples
- 200
{- "sessionId": "string",
- "name": "string",
- "givenName": "string",
- "familyName": "string",
- "serialNumber": "string",
- "eips": "string"
}
signDocument_4
path Parameters
provider required | string |
id required | string |
Request Body schema: application/json
phoneNo | string |
idCode | string |
country | string |
displayText | string |
displayTextLong | string |
role | string |
documentNumber | string |
delay | integer <int32> |
callbackUrl | string |
hashToSign | string |
signatureLocation | string |
signatureReason | string |
signatureContactInfo | string |
certInHex | string |
pdfSignatureIsVisible | boolean |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signatureProfile | string |
signingInfo | object |
forcePin | boolean |
font | string |
signerTextVerticalPosition | string |
signatureImageScaling | string |
Responses
Request samples
- Payload
{- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string",
- "signatureLocation": "string",
- "signatureReason": "string",
- "signatureContactInfo": "string",
- "certInHex": "string",
- "pdfSignatureIsVisible": true,
- "pdfSignatureVisuals": {
- "signatureImage": "string",
- "signatureText": "string",
- "signatureXAxis": 0,
- "signatureYAxis": 0,
- "signatureZoom": 0,
- "signaturePage": 0,
- "sigMod2XIndent": 0,
- "sigMod2YIndent": 0,
- "signatureFieldHeight": 0,
- "signatureFieldWidth": 0
}, - "pdfAdditionalText": {
- "text": "string",
- "x": 0,
- "y": 0,
- "font": "string",
- "fontSize": 0,
- "page": 0,
- "colour": {
- "r": 0,
- "g": 0,
- "b": 0
}, - "transparency": 0.1
}, - "label": "string",
- "signatureProfile": "string",
- "signingInfo": { },
- "forcePin": true,
- "font": "string",
- "signerTextVerticalPosition": "string",
- "signatureImageScaling": "string"
}
signDocument_5
path Parameters
provider required | string |
id required | string |
Request Body schema: application/json
phoneNo | string |
idCode | string |
country | string |
displayText | string |
displayTextLong | string |
role | string |
documentNumber | string |
delay | integer <int32> |
callbackUrl | string |
hashToSign | string |
signatureLocation | string |
signatureReason | string |
signatureContactInfo | string |
certInHex | string |
pdfSignatureIsVisible | boolean |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signatureProfile | string |
signingInfo | object |
forcePin | boolean |
font | string |
signerTextVerticalPosition | string |
signatureImageScaling | string |
Responses
Request samples
- Payload
{- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string",
- "signatureLocation": "string",
- "signatureReason": "string",
- "signatureContactInfo": "string",
- "certInHex": "string",
- "pdfSignatureIsVisible": true,
- "pdfSignatureVisuals": {
- "signatureImage": "string",
- "signatureText": "string",
- "signatureXAxis": 0,
- "signatureYAxis": 0,
- "signatureZoom": 0,
- "signaturePage": 0,
- "sigMod2XIndent": 0,
- "sigMod2YIndent": 0,
- "signatureFieldHeight": 0,
- "signatureFieldWidth": 0
}, - "pdfAdditionalText": {
- "text": "string",
- "x": 0,
- "y": 0,
- "font": "string",
- "fontSize": 0,
- "page": 0,
- "colour": {
- "r": 0,
- "g": 0,
- "b": 0
}, - "transparency": 0.1
}, - "label": "string",
- "signatureProfile": "string",
- "signingInfo": { },
- "forcePin": true,
- "font": "string",
- "signerTextVerticalPosition": "string",
- "signatureImageScaling": "string"
}
signBatch
path Parameters
provider required | string |
Request Body schema: application/jsonrequired
documents required | Array of strings |
object (PDFSigningSigner) |
Responses
Request samples
- Payload
{- "documents": [
- "string"
], - "pdfSigner": {
- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string",
- "signatureLocation": "string",
- "signatureReason": "string",
- "signatureContactInfo": "string",
- "certInHex": "string",
- "pdfSignatureIsVisible": true,
- "pdfSignatureVisuals": {
- "signatureImage": "string",
- "signatureText": "string",
- "signatureXAxis": 0,
- "signatureYAxis": 0,
- "signatureZoom": 0,
- "signaturePage": 0,
- "sigMod2XIndent": 0,
- "sigMod2YIndent": 0,
- "signatureFieldHeight": 0,
- "signatureFieldWidth": 0
}, - "pdfAdditionalText": {
- "text": "string",
- "x": 0,
- "y": 0,
- "font": "string",
- "fontSize": 0,
- "page": 0,
- "colour": {
- "r": 0,
- "g": 0,
- "b": 0
}, - "transparency": 0.1
}, - "label": "string",
- "signatureProfile": "string",
- "signingInfo": { },
- "forcePin": true,
- "font": "string",
- "signerTextVerticalPosition": "string",
- "signatureImageScaling": "string"
}
}
signPdf
path Parameters
id required | string |
query Parameters
locale | string Default: "" |
signatureProfile | string Default: "LT" |
role | string Default: "" |
additionalData | string |
authRedirectUri | string Default: "" |
signRedirectUri | string Default: "" |
state | string Default: "" |
Request Body schema: application/json
phoneNo | string |
idCode | string |
country | string |
displayText | string |
displayTextLong | string |
role | string |
documentNumber | string |
delay | integer <int32> |
callbackUrl | string |
hashToSign | string |
signatureLocation | string |
signatureReason | string |
signatureContactInfo | string |
certInHex | string |
pdfSignatureIsVisible | boolean |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signatureProfile | string |
signingInfo | object |
forcePin | boolean |
font | string |
signerTextVerticalPosition | string |
signatureImageScaling | string |
Responses
Request samples
- Payload
{- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string",
- "signatureLocation": "string",
- "signatureReason": "string",
- "signatureContactInfo": "string",
- "certInHex": "string",
- "pdfSignatureIsVisible": true,
- "pdfSignatureVisuals": {
- "signatureImage": "string",
- "signatureText": "string",
- "signatureXAxis": 0,
- "signatureYAxis": 0,
- "signatureZoom": 0,
- "signaturePage": 0,
- "sigMod2XIndent": 0,
- "sigMod2YIndent": 0,
- "signatureFieldHeight": 0,
- "signatureFieldWidth": 0
}, - "pdfAdditionalText": {
- "text": "string",
- "x": 0,
- "y": 0,
- "font": "string",
- "fontSize": 0,
- "page": 0,
- "colour": {
- "r": 0,
- "g": 0,
- "b": 0
}, - "transparency": 0.1
}, - "label": "string",
- "signatureProfile": "string",
- "signingInfo": { },
- "forcePin": true,
- "font": "string",
- "signerTextVerticalPosition": "string",
- "signatureImageScaling": "string"
}
signDocument_6
path Parameters
id required | string |
query Parameters
locale | string Default: "" |
signatureProfile | string Default: "LT" |
role | string Default: "" |
additionalData | string |
authRedirectUri | string Default: "" |
signRedirectUri | string Default: "" |
state | string Default: "" |
Request Body schema: application/json
phoneNo | string |
idCode | string |
country | string |
displayText | string |
displayTextLong | string |
role | string |
documentNumber | string |
delay | integer <int32> |
callbackUrl | string |
hashToSign | string |
signatureLocation | string |
signatureReason | string |
signatureContactInfo | string |
certInHex | string |
pdfSignatureIsVisible | boolean |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signatureProfile | string |
signingInfo | object |
forcePin | boolean |
font | string |
signerTextVerticalPosition | string |
signatureImageScaling | string |
Responses
Request samples
- Payload
{- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string",
- "signatureLocation": "string",
- "signatureReason": "string",
- "signatureContactInfo": "string",
- "certInHex": "string",
- "pdfSignatureIsVisible": true,
- "pdfSignatureVisuals": {
- "signatureImage": "string",
- "signatureText": "string",
- "signatureXAxis": 0,
- "signatureYAxis": 0,
- "signatureZoom": 0,
- "signaturePage": 0,
- "sigMod2XIndent": 0,
- "sigMod2YIndent": 0,
- "signatureFieldHeight": 0,
- "signatureFieldWidth": 0
}, - "pdfAdditionalText": {
- "text": "string",
- "x": 0,
- "y": 0,
- "font": "string",
- "fontSize": 0,
- "page": 0,
- "colour": {
- "r": 0,
- "g": 0,
- "b": 0
}, - "transparency": 0.1
}, - "label": "string",
- "signatureProfile": "string",
- "signingInfo": { },
- "forcePin": true,
- "font": "string",
- "signerTextVerticalPosition": "string",
- "signatureImageScaling": "string"
}
signBatch_1
query Parameters
locale | string Default: "" |
signatureProfile | string Default: "LT" |
role | string Default: "" |
additionalData | string |
authRedirectUri | string Default: "" |
signRedirectUri | string Default: "" |
state | string Default: "" |
Request Body schema: application/jsonrequired
documents required | Array of strings |
object (PDFSigningSigner) |
Responses
Request samples
- Payload
{- "documents": [
- "string"
], - "pdfSigner": {
- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string",
- "signatureLocation": "string",
- "signatureReason": "string",
- "signatureContactInfo": "string",
- "certInHex": "string",
- "pdfSignatureIsVisible": true,
- "pdfSignatureVisuals": {
- "signatureImage": "string",
- "signatureText": "string",
- "signatureXAxis": 0,
- "signatureYAxis": 0,
- "signatureZoom": 0,
- "signaturePage": 0,
- "sigMod2XIndent": 0,
- "sigMod2YIndent": 0,
- "signatureFieldHeight": 0,
- "signatureFieldWidth": 0
}, - "pdfAdditionalText": {
- "text": "string",
- "x": 0,
- "y": 0,
- "font": "string",
- "fontSize": 0,
- "page": 0,
- "colour": {
- "r": 0,
- "g": 0,
- "b": 0
}, - "transparency": 0.1
}, - "label": "string",
- "signatureProfile": "string",
- "signingInfo": { },
- "forcePin": true,
- "font": "string",
- "signerTextVerticalPosition": "string",
- "signatureImageScaling": "string"
}
}
generateHashForPDFExistingEndpoint
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string |
idCode | string |
country | string |
displayText | string |
displayTextLong | string |
role | string |
documentNumber | string |
delay | integer <int32> |
callbackUrl | string |
hashToSign | string |
signatureLocation | string |
signatureReason | string |
signatureContactInfo | string |
certInHex | string |
pdfSignatureIsVisible | boolean |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signatureProfile | string |
signingInfo | object |
forcePin | boolean |
font | string |
signerTextVerticalPosition | string |
signatureImageScaling | string |
Responses
Request samples
- Payload
{- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string",
- "signatureLocation": "string",
- "signatureReason": "string",
- "signatureContactInfo": "string",
- "certInHex": "string",
- "pdfSignatureIsVisible": true,
- "pdfSignatureVisuals": {
- "signatureImage": "string",
- "signatureText": "string",
- "signatureXAxis": 0,
- "signatureYAxis": 0,
- "signatureZoom": 0,
- "signaturePage": 0,
- "sigMod2XIndent": 0,
- "sigMod2YIndent": 0,
- "signatureFieldHeight": 0,
- "signatureFieldWidth": 0
}, - "pdfAdditionalText": {
- "text": "string",
- "x": 0,
- "y": 0,
- "font": "string",
- "fontSize": 0,
- "page": 0,
- "colour": {
- "r": 0,
- "g": 0,
- "b": 0
}, - "transparency": 0.1
}, - "label": "string",
- "signatureProfile": "string",
- "signingInfo": { },
- "forcePin": true,
- "font": "string",
- "signerTextVerticalPosition": "string",
- "signatureImageScaling": "string"
}
generateHashForPDFExistingEndpointDSS
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string |
idCode | string |
country | string |
displayText | string |
displayTextLong | string |
role | string |
documentNumber | string |
delay | integer <int32> |
callbackUrl | string |
hashToSign | string |
signatureLocation | string |
signatureReason | string |
signatureContactInfo | string |
certInHex | string |
pdfSignatureIsVisible | boolean |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signatureProfile | string |
signingInfo | object |
forcePin | boolean |
font | string |
signerTextVerticalPosition | string |
signatureImageScaling | string |
Responses
Request samples
- Payload
{- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string",
- "signatureLocation": "string",
- "signatureReason": "string",
- "signatureContactInfo": "string",
- "certInHex": "string",
- "pdfSignatureIsVisible": true,
- "pdfSignatureVisuals": {
- "signatureImage": "string",
- "signatureText": "string",
- "signatureXAxis": 0,
- "signatureYAxis": 0,
- "signatureZoom": 0,
- "signaturePage": 0,
- "sigMod2XIndent": 0,
- "sigMod2YIndent": 0,
- "signatureFieldHeight": 0,
- "signatureFieldWidth": 0
}, - "pdfAdditionalText": {
- "text": "string",
- "x": 0,
- "y": 0,
- "font": "string",
- "fontSize": 0,
- "page": 0,
- "colour": {
- "r": 0,
- "g": 0,
- "b": 0
}, - "transparency": 0.1
}, - "label": "string",
- "signatureProfile": "string",
- "signingInfo": { },
- "forcePin": true,
- "font": "string",
- "signerTextVerticalPosition": "string",
- "signatureImageScaling": "string"
}
generateHashDocument
path Parameters
id required | string |
Request Body schema: application/jsonrequired
phoneNo | string |
idCode | string |
country | string |
displayText | string |
displayTextLong | string |
role | string |
documentNumber | string |
delay | integer <int32> |
callbackUrl | string |
hashToSign | string |
signatureLocation | string |
signatureReason | string |
signatureContactInfo | string |
certInHex | string |
pdfSignatureIsVisible | boolean |
object (PDFSignatureVisuals) | |
object (PDFTextVisuals) | |
label | string |
signatureProfile | string |
signingInfo | object |
forcePin | boolean |
font | string |
signerTextVerticalPosition | string |
signatureImageScaling | string |
Responses
Request samples
- Payload
{- "phoneNo": "string",
- "idCode": "string",
- "country": "string",
- "displayText": "string",
- "displayTextLong": "string",
- "role": "string",
- "documentNumber": "string",
- "delay": 0,
- "callbackUrl": "string",
- "hashToSign": "string",
- "signatureLocation": "string",
- "signatureReason": "string",
- "signatureContactInfo": "string",
- "certInHex": "string",
- "pdfSignatureIsVisible": true,
- "pdfSignatureVisuals": {
- "signatureImage": "string",
- "signatureText": "string",
- "signatureXAxis": 0,
- "signatureYAxis": 0,
- "signatureZoom": 0,
- "signaturePage": 0,
- "sigMod2XIndent": 0,
- "sigMod2YIndent": 0,
- "signatureFieldHeight": 0,
- "signatureFieldWidth": 0
}, - "pdfAdditionalText": {
- "text": "string",
- "x": 0,
- "y": 0,
- "font": "string",
- "fontSize": 0,
- "page": 0,
- "colour": {
- "r": 0,
- "g": 0,
- "b": 0
}, - "transparency": 0.1
}, - "label": "string",
- "signatureProfile": "string",
- "signingInfo": { },
- "forcePin": true,
- "font": "string",
- "signerTextVerticalPosition": "string",
- "signatureImageScaling": "string"
}
encryptFileSerials
query Parameters
ldapProfile required | string Ldap profile |
filters required | Array of strings Recipient filters |
containerName | string Cdoc container name |
Request Body schema: multipart/form-data
file required | Array of strings <binary> [ items <binary > ] Files to be added to container |
Responses
createContainerSerials
query Parameters
documentData required | string DocumentData |
ldapProfile required | string Ldap profile |
filters required | Array of strings Recipient filters |
Request Body schema: multipart/form-data
file required | Array of strings <binary> [ items <binary > ] Files to be added to container |
Responses
Response samples
- 200
{- "signatures": [
- {
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
]
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
], - "documentMimeType": "string",
- "objectName": "string"
}
Request samples
- Payload
"string"
Response samples
- 200
{- "containerId": "string",
- "containerInfo": {
- "signatures": [
- {
- "signerRoles": [
- "string"
], - "signatureMethod": "string",
- "claimedSigningTime": "2019-08-24T14:15:22Z",
- "idCode": "string",
- "givenName": "string",
- "lastName": "string",
- "commonName": "string",
- "organization": "string",
- "validationErrors": [
- { }
], - "validationWarnings": [
- { }
]
}
], - "files": [
- {
- "fileName": "string",
- "fileSize": 0,
- "mimeType": "string"
}
], - "validationErrors": [
- "string"
]
}
}
createContainerFromDocuments_2
Request Body schema: application/jsonrequired
documentId | string |
newDocumentName | string |
Array of objects (DocumentIdNamePair) |
Responses
Request samples
- Payload
{- "documentId": "string",
- "newDocumentName": "string",
- "containerDocuments": [
- {
- "documentId": "string",
- "fileName": "string"
}
]
}
Add file to container.
Add file to existing container file(s) provided by request.
query Parameters
fileName | Array of strings File names if attached file original name will be replaced |
Request Body schema: multipart/form-data
container required | string <binary> Container files will be added to |
file required | Array of strings <binary> [ items <binary > ] Files to be added to container |