Customer status change

Webhook that is called when the status of a customer is updated, including KYC and KYB status changes. This endpoint should be implemented by clients of the Grid API.

Authentication

The webhook includes a signature in the X-Grid-Signature header that allows you to verify that the webhook was sent by Grid. To verify the signature:

1. Get the Grid API public key provided to you during integration
2. Decode the base64 signature from the header
3. Create a SHA-256 hash of the request body
4. Verify the signature using the public key and the hash

If the signature verification succeeds, the webhook is authentic. If not, it should be rejected.

WEBHOOK customer-update

JSON

kycApprovedWebhook

{ "id": "Webhook:019542f5-b3e7-1d02-0000-000000000007", "type": "CUSTOMER.KYC_APPROVED", "timestamp": "2025-08-15T14:32:00Z", "data": { "id": "Customer:019542f5-b3e7-1d02-0000-000000000001", "platformCustomerId": "9f84e0c2a72c4fa", "customerType": "INDIVIDUAL", "agreementConsents": [ { "type": "LIGHTSPARK_END_USER_TERMS", "acceptedAt": "2025-07-21T17:30:00Z", "ipAddress": "203.0.113.42", "termsVersion": "2025-10-13", "acceptanceMethod": "CHECKBOX" } ], "region": "US", "currencies": [ "USD", "USDC" ], "umaAddress": "$[e-mail]", "kycStatus": "APPROVED", "fullName": "John Michael Doe", "birthDate": "1990-01-15", "nationality": "US", "address": { "line1": "123 Main Street", "line2": "Apt 4B", "city": "Seattle", "state": "WA", "postalCode": "98101", "country": "US" }, "createdAt": "2025-07-21T17:32:28Z", "updatedAt": "2025-07-21T17:32:28Z", "isDeleted": false } }

400

{
  "code": "INVALID_INPUT",
  "reason": "<string>",
  "details": {
    "errors": [
      {
        "field": "identifier",
        "constraint": {
          "format": "email",
          "pattern": "^\\d{5}(-\\d{4})?$",
          "enum": [
            "SSN",
            "ITIN",
            "NON_US_TAX_ID"
          ],
          "minLength": 1,
          "maxLength": 500
        },
        "message": "Value is not one of the allowed enum members."
      }
    ],
    "missingRequirements": [
      "SUPPORTING_PROOF"
    ],
    "refusalReason": "AGENT_POLICY_DENIED",
    "missingFields": [
      "PHONE_NUMBER"
    ]
  }
}

Authorizations

X-Grid-Signature · string · header · required

Secp256r1 (P-256) asymmetric signature of the webhook payload, which can be used to verify that the webhook was sent by Grid. To verify the signature:

1. Get the Grid public key provided to you during integration
2. Decode the base64 signature from the header
3. Create a SHA-256 hash of the request body
4. Verify the signature using the public key and the hash

If the signature verification succeeds, the webhook is authentic. If not, it should be rejected.

Body

application/json

id · string · required

Unique identifier for this webhook delivery (can be used for idempotency)

Example:

"Webhook:019542f5-b3e7-1d02-0000-000000000007"

type · enum<string> · required

Status-specific event type in OBJECT.EVENT dot-notation (e.g., OUTGOING_PAYMENT.COMPLETED)

Available options: CUSTOMER.KYC_APPROVED, CUSTOMER.KYC_REJECTED, CUSTOMER.KYC_PENDING, CUSTOMER.KYB_APPROVED, CUSTOMER.KYB_REJECTED, CUSTOMER.KYB_PENDING

timestamp · string<date-time> · required

ISO 8601 timestamp of when the webhook was sent

Example:

"2025-08-15T14:32:00Z"

data · Individual Customer · object · required

Enhanced-due-diligence (EDD) fields available as optional patchable attributes on an individual customer. Referenced via allOf from IndividualCustomerFields, so these appear as top-level optional fields on the customer resource itself; there is no separate EDD resource. The specific set required for a given customer is driven by the KYC provider's per-jurisdiction / per-flow / per-volume-tier rules (surfaced through MISSING_FIELD errors on POST /verifications).

Individual Customer

Business Customer

Show child attributes

Response

200

Webhook received successfully