Skip to main content
GET
Download a signature image
Returns, as a PNG, the signature or initials a signer applied to a field. The path is in the field’s image_url, in signatures[].documents[].fields[], so you don’t need to build it. It needs read:sessions.
A drawn signature is the image the signer drew, and it’s the image stamped into the signed PDF. A typed signature is their verified name in the handwriting style they chose, and the signed PDF carries it as text in the same style. For proof of the signature itself, use the signed document and the evidence. A field that isn’t the signer’s, or has no applied signature or initials, returns 404 with signature_field_not_found. A stored image that no longer matches its recorded SHA-256 returns 400 with signature_document_changed. After you delete the session, the route returns 404.

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Path Parameters

sessionId
string<uuid>
required

The User Verification (KYC) or Business Verification (KYB) session.

Example:

"11111111-2222-3333-4444-555555555555"

nodeId
string
required

The Electronic Signature step: node_id of the item in signatures[].

Example:

"feature_signature"

fieldId
string<uuid>
required

The field on this signer's copy, as in the field's image_url.

Response

The image.

The response is of type file.