Skip to content
Webhooks
/
/
IDENTIFICATION_ORIGINATIO...

Webhooks (1.0)

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

https://docs.solarisgroup.com/_mock/api-reference/onboarding/webhooks/

Webhook subscription

Operations

Webhook events

Webhooks

IDENTIFICATIONWebhook

Request

A person identification was created, or its status was updated. The primary purpose of this webhook is to deliver the URL where the customer must be redirected to complete a video identification.

Bodyapplication/json
idstring

ID of the person identification.

Example: "9dfe2f4edaa67138be0c0c1cd3a7d849cidt"
referencestring

Reference generated by the identification provider.

Example: "TST-ELCCJ"
urlstring

(IDnow only) Redirect URL used to start the identification process.

Example: "https://go.test.idnow.de/"
statusstring

The current status of the identification. Note The status value depends on the identification method, check the KYC guides for more information.

Enum"aborted""authorization_required""confirmation_required""confirmed""created""canceled""expired""failed""identification_data_required""pending"
Example: "successful"
completed_atstring

Date and time when the identification was completed.

Example: "2021-09-14T18:18:28.000Z"
methodstring

The method used for the identification.

Enum"bank""bank_id""bank_plus""fourthline""idnow""idnow_autoident""manual""postident"
Example: "idnow"
metadataobject
application/json
{
  "id": "9dfe2f4edaa67138be0c0c1cd3a7d849cidt",
  "reference": "TST-ELCCJ",
  "url": "https://go.test.idnow.de/",
  "status": "successful",
  "completed_at": "2021-09-14T18:18:28.000Z",
  "method": "idnow",
  "metadata": {
    "account_bic": "SOBKDEB2XXX",
    "account_currency": "EUR",
    "account_id": "string",
    "iban": "string"
  }
}

Responses

Return 200 to indicate that you successfully received the webhook notification.

IDENTIFICATION_ORIGINATIONWebhook

Request

The status of an identification origination has changed.

Bodyapplication/json
identification_origination_idstringrequired

The unique ID of an identification origination resource assigned to a specific customer.

Example: "589e12da53154010ad180894acbe07ebio"
statusstringrequired

The status of the identification origination.

Enum"identification_trigger_pending""esign_pending""identification_completion_pending""screening_pending""failed""completed""expired"
Example: "esign_pending"
status_descriptionstring or null

The description of the identification status

Example: "Waiting for signing process to finish"
identification_idstring or null

The unique ID of the identification resource assigned to a specific customer.

Example: "17905779039e75dce7bf8d68f3184942cidt"
esigning_idstring or null

The unique ID of the e-signing resource.

Example: "5ade4e499b299c299be2987ad597c42ecsig"
application/json
{
  "status_description": "Waiting for signing process to finish",
  "status": "esign_pending",
  "identification_origination_id": "589e12da53154010ad180894acbe07ebio",
  "identification_id": "17905779039e75dce7bf8d68f3184942cidt",
  "esigning_id": "5ade4e499b299c299be2987ad597c42ecsig"
}

Responses

Return 200 to indicate that you successfully received the webhook notification.

IDENTIFICATION_REFERENCE_TRANSFER_ATTEMPTWebhook

Request

Optional webhook for bank_plus identification. Notifies about the remaining number of reference transfer attempts.

Bodyapplication/json
idstring

ID of the person identification.

Example: "9dfe2f4edaa67138be0c0c1cd3a7d849cidt"
methodstring

The method used for the identification.

Example: "bank_plus"
person_idstring

ID of the person.

Example: "992de312a545bb24a88ddbf57ae8b1ffcper"
remaining_attemptsinteger

Remaining attempts for the reference transfer.

Example: 2
Reasonstring

Reason for the failure of reference transfer.

Example: "name_not_matched"
application/json
{
  "id": "9dfe2f4edaa67138be0c0c1cd3a7d849cidt",
  "method": "bank_plus",
  "person_id": "992de312a545bb24a88ddbf57ae8b1ffcper",
  "remaining_attempts": 2,
  "Reason": "name_not_matched"
}

Responses

Return 200 to indicate that you successfully received the webhook notification.