Argyle · Schema

PartnerVerificationWebhookMessage

Employment DataPayrollIncome VerificationGig EconomyFinancial DataEmployment HistoryEarned Wage AccessDirect Deposit

Properties

Name Type Description
event string `verifications.updated`
name string Name used for the webhook subscription.
data object
View JSON Schema on GitHub

JSON Schema

partnerverificationwebhookmessage.json Raw ↑ 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/argyle/refs/heads/main/json-schema/partnerverificationwebhookmessage.json",
  "title": "PartnerVerificationWebhookMessage",
  "type": "object",
  "properties": {
    "event": {
      "type": "string",
      "description": "`verifications.updated`",
      "example": "verifications.updated"
    },
    "name": {
      "type": "string",
      "description": "Name used for the webhook subscription."
    },
    "data": {
      "type": "object",
      "properties": {
        "user": {
          "type": "string",
          "format": "uuid",
          "description": "ID of the user.",
          "example": "018051aa-f7a9-a0db-2f38-6cfa325e9d69"
        },
        "verification": {
          "type": "string",
          "format": "uuid",
          "description": "ID of the verification.",
          "example": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b"
        },
        "client": {
          "type": "string",
          "format": "uuid",
          "description": "ID of the client.",
          "example": "39096494-45c8-4fd8-9454-3d1cb2d62db7"
        },
        "resource": {
          "$ref": "#/components/schemas/PartnerVerification"
        }
      }
    }
  }
}