Identity Verification Webhook - Production Approved

The IDENTITY_VERIFICATION webhook is sent when Rapyd completes the process of verifying a person’s identity.

Parameters

Webhook Header Parameters

Webhook Root Parameters

- created_at
- Time that the webhook was created, in Unix time.
  Note
  Inside the data object, some webhooks have another created_at field that refers to a different event.
- data
- Contains the actual data of the webhook.
  For details, see below.
- extended_timestamp
- Time in milliseconds that the webhook was created, in Unix time.
- id
- ID of the webhook. String starting with wh_.
- status
- Status of the webhook. One of the following:
  - NEW
  - CLO - Closed.
  - ERR - Error.
  - RET - Re-sent.
  Note
  Inside the data object, some webhooks have another status field that refers to a different event.
- trigger_operation_id
- ID of the operation that triggered the webhook. UUID.
- type
- Name of the webhook type.
  Note
  The name in the Client Portal is different.

Webhook Data Parameters

- additional_data
- Additional data.
- address
- The address of the individual.
- contact
- ID of the wallet contact. String starting with cont_.
- country
- The two-letter ISO 3166-1 ALPHA-2 code for the country of the identification document.
- country_match
- Indicates whether the individual's country matches the country on the identification document.
- created_at
- Time of the identity verification operation, in Unix time.
- date_of_birth
- Date of birth of the individual.
- dob_match
- Indicates whether the individual's date of birth matches the date of birth on the identification document.
- document_sub_type
- Subtype of the identification document.
- document_type
- Type of identification document. Two-letter code.
- error_reason
- Reason for not approving the verification request.
- ewallet
- ID of the Rapyd Wallet. String starting with ewallet_.
- ewallet_id
- ID of the Rapyd Wallet. String starting with ewallet_.
- expiration_date
- Reserved.
- face_validation
- Indicates whether face verification was performed.
- first_name
- First name of the individual.
- gender
- Gender of the individual.
- id
- ID of the identity verification operation. String starting with kycid_.
- id_number
- ID number as shown on the identification document.
- images
- Link to the images that were used for this verification.
- last_name
- Last name of the individual.
- name_match
- Indicates whether the individual's full name matches the full name on the identification document.
- reference_id
- ID of the identity verification request. Must be unique for each request. Defined by the client.
- reject_reason
- Reason for not approving the individual. See Identity Verification Errors.
- request_source
- Type of device that supplied the images.
- state
- State of residence of the individual, as shown on the identification document.
- verification_status
- Indicates whether the individual was approved. One of the following:
  - APPROVED - The individual was approved.
  - NOT_APPROVED - The individual was not approved.

IDENTITY_VERIFICATION Webhook (Production - approved)

{
    "id": "wh_fdb4bd293f926e624c6c98587f3a682f",
    "data": {
        "id": "kycid_598fcfb178e6c5317e6f9f22e196a27b",
        "reference_id": "01F4XZZAR93FDPMZ9NMM5R5POP",
        "ewallet": "ewallet_82d23a5dde96fd2cbf5476c4f63a1d2f",
        "ewallet_id": "ewallet_82d23a5dde96fd2cbf5476c4f63a1d2f",
        "contact_id": "cont_1f7ff45b955dd2f0c1995a4bf582d205",
        "verification_status": "APPROVED",
        "reject_reason": null,
        "request_source": "API",
        "document_type": "ID_CARD",
        "document_sub_type": null,
        "country": "DE",
        "images": "v1/kyc/identities/images?reference_id=01F4XZZAR93FDPMZ9NMM5R5DPT",
        "id_number": "L73KYVYKK",
        "first_name": "JOHN",
        "last_name": "DOE",
        "state": null,
        "expiration_date": "21/03/2024",
        "date_of_birth": "05/06/1984",
        "face_validation": true,
        "additional_data": null,
        "created_at": 1620209290,
        "gender": "male"
    },
    "type": "IDENTITY_VERIFICATION",
    "status": "NEW",
    "created_at": 1725155920,
    "extended_timestamp": 1725155920336,
    "trigger_operation_id": "85947e2e-de40-47aa-b4d1-e32dfbd68c90"
}

In this section:

Documentation

Identity Verification Webhook - Production Approved

Note

Parameters

Webhook Header Parameters

Webhook Root Parameters

Note

Note

Note

Webhook Data Parameters

Search results