WebSockets

You can connect to the WebSocket to receive information about the identification process.

Endpoint URL

wss://demo2.api.concedus.com/ws/connect 

Authentication

Set Authorization header to Bearer {{token}}

Use the accessToken received after Authentification as {{token}}

Topics

Here you can find the message topics that may be sent by the WebSocket during the onboarding process.

identRequestCreated

You receive this message when a customer or contract record has been successfully sent. It contains the KYC provider and the verification link that the registered user can now use for verification.

identResult

You receive this message when the user has completed the verification. Depending on the status, the verification was successful or failed.

{
        "topic": "identResult",
        "kyc": "WEBID",
        "identId": "166956507",
        "personKey": "PERS_c8f24e33-bdef-xxx2-ab7f-VER0007",
        "reason": null,
        "status": "success"
}

identResultKYC

Like identResult, but this message also contains attachments sent by the KYC provider. Only usable in certain cases, depending on the contract.

mismatches

You receive this message if there were mismatches between the data sent by you and the data sent by the KYC-provider. The exact mismatches can be read in the message body. The structure should always be equal for all KYC providers used.

{
        "topic": "mismatches",
        "mismatches": [
            {
                "IdentId": "166956507",
                "PersonKey": "PERS_c8f24e33-bdef-xxx2-ab7f-VER0007",
                "Created": "2023-06-01T13:23:17.706Z",
                "Mismatches": [
                    {
                        "FieldName": "BirthPlace",
                        "Value": "Frankfurt",
                        "KycValue": "Beirut"
                    },
                    {
                        "FieldName": "Nationality",
                        "Value": "DE",
                        "KycValue": "lb"
                    }
                ]
            }
        ]
}

complianceRecord

When the verification was completed a compliance record is sent (See: Compliance Records).

{
        "topic": "complianceRecord",
        "complianceRecord": [
            {
                "status": 100,
                "key": "a8f8a836c84c4326ba0ac2727f09a2e6",
                "modified": "2023-06-01T13:23:17",
                "customerKey": "CUS_c8f24e33-bdef-xxx2-ab7f-VER0007"
            }
        ]
}

Methods

You can send a message with these methods to the WebSocket

Get Topics

Show which topics are available / enabled for you

• getAvailableTopics

{
    "topic": "method",
    "method": "getAvailableTopics"
}

• getEnabledTopics

{
    "topic": "method",
    "method": "getEnabledTopics"
}

Get Messages

{
    "topic": "method",
    "method": "getLastMessages"
}

The method getLastMessages can be specified with parameters:

Property	Type	Description
since	string (ISO 8601)	show only messages since specific timedate
count	integer	show only a specific amount of messages
topics	array of string	show only messages with specific topics (see: Topics)

Example

{
    "topic": "method",
    "method": "getLastMessages",
    "since":"2022-09-20T11:31:42.937+00:00",
    "count": 2,
    "topics": [
        "identResult",
    ]
}

Show the last 2 messages since 2022-09-20T11:31:42.937+00:00 with the topic identResult