Sign in
Person signings

Upload documents for the e-signature process

Uploads documents that are required for the e-signature process in an IDnow identification. You must specify the position of the signature in the document and the type of document in the request. The options for document type are cdoc (for contracts) and ldoc (for SDD mandates).

post/v1/persons/{person_id}/signings

Path parameters

person_idstring required

The unique ID of the person resource created for a customer.

Example:dc1a6812a14f6cc338cd084208535bcdcper

Request body

method'idnow' | 'postident' required

The identification method for which the documents are being uploaded.

language'DE' | 'EN'

The customer's preferred language for the IDnow agent.

Example request

{
  "method": "idnow",
  "language": "EN",
  "documents": [
    {
      "data": {
        "type": "base64",
        "value": ""
      },
      "identifier": "cdoc",
      "definition": {
        "signatures": {
          "mysignature1": {
            "position": {
              "page": "1",
              "left": 50,
              "width": 50,
              "bottom": 50,
              "height": 50
            }
          }
        }
      }
    }
  ]
}

Response

Successful result of the operation

idstring

ID of the signing.

referencestring

Reference provided for the signing.

urlstring

URL of the signing.

state'created' | 'expired' | 'failed' | 'pending' | 'successful'

The current state of the signing.

status'created' | 'expired' | 'failed' | 'finished' | 'pending'

The current status of the signing.

completed_atstring

Date and time when the signing was completed.

methodstring

Method used to complete the signing.

identification_idstring

ID of the related person identification.

Example response

{
  "id": "7da925f612600ee0a2c386afe1cac4bccsig",
  "reference": "TST-QMNBB",
  "url": "https://go.test.idnow.de/solarisbankesignsandbox/identifications/155b0818593319dd718e2ec139718973cidt/webcam",
  "state": "successful",
  "status": "finished",
  "completed_at": "2020-04-08T12:53:42.000Z",
  "method": "idnow",
  "identification_id": "155b0818593319dd718e2ec139718973cidt",
  "documents": [
    {
      "id": "99167f972843c1bd4db0b55719e70df9cdoc",
      "name": "155b0818593319dd718e2ec139718973cidt_ldoc_signed.pdf",
      "content_type": "application/pdf",
      "document_type": "SIGNED_CONTRACT",
      "size": 210012,
      "customer_accessible": false,
      "created_at": "2020-04-08T12:53:56.000Z"
    },
    {
      "id": "d3e6e5552009db11ca0b004836d53512cdoc",
      "name": "155b0818593319dd718e2ec139718973cidt_cdoc_signed.pdf",
      "content_type": "application/pdf",
      "document_type": "SIGNED_CONTRACT",
      "size": 210012,
      "customer_accessible": false,
      "created_at": "2020-04-08T12:53:57.000Z"
    },
    {
      "id": "5d4cbca60126f0e25503b0332f10ead8cdoc",
      "name": "155b0818593319dd718e2ec139718973cidt.xml",
      "content_type": "application/xml",
      "document_type": "OTHER",
      "size": 2894,
      "customer_accessible": false,
      "created_at": "2020-04-08T12:53:57.000Z"
    },
    {
      "id": "03bfa749ce3b9e6ad41f398c32d7c1eecdoc",
      "name": "155b0818593319dd718e2ec139718973cidt.xml.sig",
      "content_type": "application/pgp-signature",
      "document_type": "SIGNATURE",
      "size": 256,
      "customer_accessible": false,
      "created_at": "2020-04-08T12:53:58.000Z"
    }
  ]
}