Skip to content
Webhooks
/
/
IDENTIFICATION

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

INCOMING_REJECTED_TRANSACTIONWebhook

Request

An incoming transaction to an account was rejected. This webhook is relevant for Restricted Accounts, Decoupled Cards, and Credit Cards. The webhook payload will differ depending on the product.

Bodyapplication/json
One of:

Webhook payload for Decoupled and Credit Cards.

statusstring

The current status of the transaction.

Example: "RETURNED"
status_reasonstring

The reason why the transaction was rejected.

Example: "The debtor name is not matching"
sender_namestring

The name of the person who sent the funds.

Example: "John Mustermann"
sender_ibanstring

IBAN of the account from which the funds were sent.

Example: "DE32110101001000000029"
person_idstring

ID of the person who owns the restricted account.

Example: "c77044e6a8e35e3a4deaf7c9a4cc2476cper"
business_idstring

ID of the business who owns the restricted account.

Example: "567eaf2b22fce21a1920e14e11e2bfa3cbiz"
account_idstring

ID of the restricted account.

Example: "c61ca1f2fbf12830517ae2fce6e2cd79cacc"
application/json
{
  "status": "RETURNED",
  "status_reason": "The debtor name is not matching",
  "sender_name": "John Mustermann",
  "sender_iban": "DE32110101001000000029",
  "person_id": "c77044e6a8e35e3a4deaf7c9a4cc2476cper",
  "business_id": "567eaf2b22fce21a1920e14e11e2bfa3cbiz",
  "account_id": "c61ca1f2fbf12830517ae2fce6e2cd79cacc"
}

Responses

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

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.