Skip to content
/Person signings

Customer Identification (KYC) (1.0)

All endpoints related to customer identifications (KYC).

Download OpenAPI description
identifications.json
identifications.yaml
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/identity/identifications/

Person identifications

Operations

Device Monitoring

Operations

Identification sessions

Operations

Person signings

Operations

(IDnow only) Index person signings

Request

Returns all of the IDnow signature packages for the person specified in the request URL.

Path
person_idstringrequired

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

Example: dc1a6812a14f6cc338cd084208535bcdcper
No request payload

Responses

Successful result of the operation

Bodyapplication/jsonArray [
idstring

ID of the signing.

Example: "7da925f612600ee0a2c386afe1cac4bccsig"
referencestring

Reference provided for the signing.

Example: "TST-QMNBB"
urlstring

URL of the signing.

Example: "https://go.test.idnow.de/solarisbankesignsandbox/identifications/155b0818593319dd718e2ec139718973cidt/webcam"
statestring

The current state of the signing.

Enum"created""expired""failed""pending""successful"
Example: "successful"
statusstring

The current status of the signing.

Enum"created""expired""failed""finished""pending"
Example: "finished"
completed_atstring

Date and time when the signing was completed.

Example: "2020-04-08T12:53:42.000Z"
methodstring

Method used to complete the signing.

Example: "idnow"
identification_idstring

ID of the related person identification.

Example: "155b0818593319dd718e2ec139718973cidt"
documentsArray of objects

Documents signed by the customer.

Example: [{"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"}]
]
Response
application/json
[
  {
    "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": [ … ]
  }
]

Upload documents for the e-signature process

Request

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).

Path
person_idstringrequired

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

Example: dc1a6812a14f6cc338cd084208535bcdcper
Bodyapplication/json

The content of the request

methodstringrequired

The identification method for which the documents are being uploaded.

Enum"idnow""postident"
Example: "idnow"
languagestring

The customer's preferred language for the IDnow agent.

Enum"DE""EN"
Example: "EN"
documentsArray of objects
Example: [{"data":{"type":"base64","value":""},"identifier":"cdoc","definition":{"signatures":{"mysignature1":{"position":{"page":"1","left":50,"width":50,"bottom":50,"height":50}}}}}]
application/json
{
  "method": "idnow",
  "language": "EN",
  "documents": [
    { … }
  ]
}

Responses

Successful result of the operation

Bodyapplication/json
idstring

ID of the signing.

Example: "7da925f612600ee0a2c386afe1cac4bccsig"
referencestring

Reference provided for the signing.

Example: "TST-QMNBB"
urlstring

URL of the signing.

Example: "https://go.test.idnow.de/solarisbankesignsandbox/identifications/155b0818593319dd718e2ec139718973cidt/webcam"
statestring

The current state of the signing.

Enum"created""expired""failed""pending""successful"
Example: "successful"
statusstring

The current status of the signing.

Enum"created""expired""failed""finished""pending"
Example: "finished"
completed_atstring

Date and time when the signing was completed.

Example: "2020-04-08T12:53:42.000Z"
methodstring

Method used to complete the signing.

Example: "idnow"
identification_idstring

ID of the related person identification.

Example: "155b0818593319dd718e2ec139718973cidt"
documentsArray of objects

Documents signed by the customer.

Example: [{"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"}]
Response
application/json
{
  "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": [
    { … },
    { … },
    { … },
    { … }
  ]
}

List the IDnow attempts of the IDnow identification used for a signing

Request

Returns a list of IDnow attempts within a person signing. Each returned attempt includes the result, the reason (if the attempt was aborted), and the payload from the webhook related to that attempt.

Path
person_idstringrequired

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

Example: dc1a6812a14f6cc338cd084208535bcdcper
signing_idstringrequired
No request payload

Responses

Successful result of the operation

Bodyapplication/json
idstring

ID of the IDnow attempt.

Example: "e1eeb07262b695dc0ee5d4ab9350c12dcida"
resultstring

Result of the IDnow attempt.

Example: "SUCCESS"
reasonstring or null

The reason why the IDnow attempt failed.

payloadobject

Payload received from the IDnow webhook for this IDnow attempt.

Example: {"identificationprocess":{"result":"SUCCESS","companyid":"solarisbankvideoidenttesting","filename":"b2d949eb12ecd6798fa8e2ae66fc4a5acidt.zip","agentname":"TROBOT","identificationtime":"2019-03-27T16:47:59+01:00","id":"TST-EABTZ","href":"/api/v1/solarisbankvideoidenttesting/identifications/b2d949eb12ecd6798fa8e2ae66fc4a5acidt.zip","type":"WEB","transactionnumber":"b2d949eb12ecd6798fa8e2ae66fc4a5acidt"},"customdata":{"custom1":null,"custom2":null,"custom3":null,"custom4":null,"custom5":null},"contactdata":{"mobilephone":"+49301234567","email":"person@example.com"},"userdata":{"birthday":{"status":"MATCH","value":"1972-12-24"},"firstname":{"status":"MATCH","value":"X-MANUALTEST-HAPPYPATH"},"address":{"zipcode":{"status":"MATCH","value":"10409"},"country":{"status":"MATCH","value":"DE"},"city":{"status":"MATCH","value":"BERLIN"},"street":{"status":"NEW","value":"STREET"}},"birthplace":{"status":"MATCH","value":"BERLIN"},"nationality":{"status":"NEW","value":"DE"},"birthname":{"status":"MATCH","value":"DOE"},"title":{"status":"NEW","value":"TITLE"},"lastname":{"status":"MATCH","value":"MUSTERMANN"}},"identificationdocument":{"country":{"status":"NEW","value":"DE"},"number":{"status":"NEW","value":"T01008921"},"issuedby":{"status":"NEW","value":"ISSUER"},"dateissued":{"status":"NEW","value":"2010-11-01"},"type":{"status":"NEW","value":"IDCARD"},"validuntil":{"status":"NEW","value":"2020-10-31"}},"attachments":{"pdf":"b2d949eb12ecd6798fa8e2ae66fc4a5acidt.pdf","signature":"b2d949eb12ecd6798fa8e2ae66fc4a5acidt_signature.jpg","xml":"b2d949eb12ecd6798fa8e2ae66fc4a5acidt.xml","videolog":"b2d949eb12ecd6798fa8e2ae66fc4a5acidt.mp4","idbackside":"b2d949eb12ecd6798fa8e2ae66fc4a5acidt_idbackside.jpg","idfrontside":"b2d949eb12ecd6798fa8e2ae66fc4a5acidt_idfrontside.jpg","security1":"b2d949eb12ecd6798fa8e2ae66fc4a5acidt_security1.jpg","userface":"b2d949eb12ecd6798fa8e2ae66fc4a5acidt_userface.jpg","security2":"b2d949eb12ecd6798fa8e2ae66fc4a5acidt_security2.jpg","security_covered":"b2d949eb12ecd6798fa8e2ae66fc4a5acidt_security_covered.jpg","security3":"b2d949eb12ecd6798fa8e2ae66fc4a5acidt_security3.jpg"}}
Response
application/json
{
  "id": "e1eeb07262b695dc0ee5d4ab9350c12dcida",
  "result": "SUCCESS",
  "reason": null,
  "payload": {
    "identificationprocess": { … },
    "customdata": { … },
    "contactdata": { … },
    "userdata": { … },
    "identificationdocument": { … },
    "attachments": { … }
  }
}

(IDnow only) Retrieve a signing

Request

Returns an IDnow e-signature package. Use this endpoint to check the status of a signing. The response includes an array of documents that the customer signed. The document_type property of signed contracts will contain the value SIGNED_CONTRACT.

Path
person_idstringrequired

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

Example: dc1a6812a14f6cc338cd084208535bcdcper
signing_idstringrequired
No request payload

Responses

Successful result of the operation.

Bodyapplication/json
idstring

ID of the signing.

Example: "7da925f612600ee0a2c386afe1cac4bccsig"
referencestring

Reference provided for the signing.

Example: "TST-QMNBB"
urlstring

URL of the signing.

Example: "https://go.test.idnow.de/solarisbankesignsandbox/identifications/155b0818593319dd718e2ec139718973cidt/webcam"
statestring

The current state of the signing.

Enum"created""expired""failed""pending""successful"
Example: "successful"
statusstring

The current status of the signing.

Enum"created""expired""failed""finished""pending"
Example: "finished"
completed_atstring

Date and time when the signing was completed.

Example: "2020-04-08T12:53:42.000Z"
methodstring

Method used to complete the signing.

Example: "idnow"
identification_idstring

ID of the related person identification.

Example: "155b0818593319dd718e2ec139718973cidt"
documentsArray of objects

Documents signed by the customer.

Example: [{"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"}]
Response
application/json
{
  "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": [
    { … },
    { … },
    { … },
    { … }
  ]
}

IDnow

Operations

Business identifications

Operations

Business screener hits

Operations