IdentityProfile Rejected

Payload

{
  "api_version": "v1",
  "data": {
    "business_address": {
      "city": "string",
      "country": "string",
      "line1": "string",
      "line2": "string",
      "postal_code": "string",
      "state": "string"
    },
    "business_name": "string",
    "business_structure": "string",
    "country": "string",
    "created_at": "2023-12-01T05:00:00.401Z",
    "date_of_birth": "string",
    "email": "string",
    "first_name": "string",
    "id": "idpf_xxxxxxxxxxxxx",
    "last_name": "string",
    "linked_companies": [
      {
        "id": "biz_xxxxxxxxxxxxxx",
        "title": "Pickaxe"
      }
    ],
    "personal_address": {
      "city": "string",
      "country": "string",
      "line1": "string",
      "line2": "string",
      "postal_code": "string",
      "state": "string"
    },
    "phone": "string",
    "profile_type": "string",
    "status": "not_started",
    "updated_at": "2023-12-01T05:00:00.401Z",
    "verifications": [
      {
        "created_at": "2023-12-01T05:00:00.401Z",
        "id": "verf_xxxxxxxxxxxxx",
        "last_error_code": "abandoned",
        "last_error_reason": "Document image was too blurry to read.",
        "session_url": "https://verify.stripe.com/session/abc123",
        "status": "requires_input"
      }
    ]
  },
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "identity_profile.rejected"
}

Sent when a identity profile is rejected

Required permissions:

identity:read
webhook_receive:identity_profiles

Payload

The payload of this webhook request is an object.

api_version"v1"Required

The API version for this webhook

dataobjectRequired

A consolidated identity or business profile synced from verification provider data.

idstringRequired

A unique ID for every single webhook request

timestampdatetimeRequired

The timestamp in ISO 8601 format that the webhook was sent at on the server

type"identity_profile.rejected"Required

The webhook event type

company_idstring or nullOptional

The company ID that this webhook event is associated with

Response

200

Return a 200 status to indicate that the data was received successfully

Headers

Payload

Response