Picture

Using metadata

Metadata can be used to store additional information about the signature requests you wish to use in some other line-of-business applications.

Available types

  • SignatureRequest

  • Signatory

  • Document

Adding a new metadata entry

Metadata values can be associated with any of the above mentioned types.

Request

PUT https://api-test.teliasign.com/metadata/{entityType}/{entityId}/{key} Authorization: Bearer {Token} Ocp-Apim-Subscription-Key: {subscription-key}  {   "value": "string",   "referenceId": "string" }

Response

{   "key": "string",   "value": "string",   "entityId": "string",   "entityType": "SignatureRequest" }

Getting signature request type metadata

You can retrieve metadata about the signature request you wish to use by calling the /metadata/signaturerequest/{signaturerequestid} endpoint.

Request

GET https://api-test.teliasign.com/metadata/{entityType}/{entityId} Authorization: Bearer {Token} Ocp-Apim-Subscription-Key: {subscription-key}

Response

{   "total": 0,   "items": [     {       "key": "string",       "value": "string",       "entityId": "string",       "entityType": "SignatureRequest"     }   ] }

You can retrieve metadata about the signature request you wish to use by calling the /metadata/{referenceId} endpoint. Note: For signature requests the ReferenceId is the SignatureRequestId.

Request

GET https://api-test.teliasign.com/metadata/{referenceId} Authorization: Bearer {Token} Ocp-Apim-Subscription-Key: {subscription-key}

Response

{   "total": 0,   "items": [     {       "key": "string",       "value": "string",       "entityId": "string",       "entityType": "SignatureRequest"     }   ] }