User Webhooks

📘
To see a complete list of all Spidr webhook fields and their descriptions, please reference: Webhook Field Index

user.create

Description: The user.create webhook contains details about a user created via the Create User endpoint.
Trigger: Successful API call to the Create User endpoint.

Example:

{
  "uuid": "1a9be5c2-366c-4d80-af28-595adc3b8773",
  "companyId": "6823a83c643d753f0f79a9ec",
  "requestId": "0b616d3004c0cb24be915552e6145b61",
  "responseBody": {
    "id": "6894eeeae754b589d02d0f11",
    "cip": {
      "status": "pass"
    },
    "spidrActionId": "6894eeeae754b589d03d0f22"
  },
  "spidrActionId": "6894eeeae754b589d03d0f22",
  "userId": "6894eeeae754b589d02d0f31",
  "productId": "6823a83e59a0f48f78787c39",
  "webhookType": "user.create",
  "actionRequestor": {
    "source": "api"
  }
}

user.edit

Description: The user.edit webhook contains details about changes that were made to a user's personal information. It will provide both the new and old values for any fields that were changed. User details can be updated via API or SST.
Triggers:
- Successful API call to the Edit User, Edit ID Number, or Update User CIP Status endpoints.
- User details updated via the appropriate SST role. If updated via SST, the userID and userEmail of the user who performed the update will be included.

{
  "uuid": "af21333c-b08d-4f1c-881a-df24707ab0e8",
  "companyId": "6823a83c643d753f0f79a7ec",
  "requestId": "d082ef13f90e844780de5c2c66d6403b",
  "responseBody": {
    "updated": true,
    "spidrActionId": "68950786e754b589d01d1339"
  },
  "spidrActionId": "68950786e754b589d01d1339",
  "userId": "68950761e754b589d02d133c",
  "webhookType": "user.edit",
  "actionRequestor": {
    "source": "api"
  },
  "changes": [
    {
      "field": "firstName",
      "oldValue": "John",
      "newValue": "Jane"
    },
    {
      "field": "dateOfBirth",
      "oldValue": "1992-03-25T00:00:00.000Z",
      "newValue": "1991-03-25T00:00:00.000Z"
    },
    {
      "field": "email",
      "oldValue": "[email protected]",
      "newValue": "[email protected]"
    },
    {
      "field": "address.address1",
      "oldValue": "123 Evergreen St",
      "newValue": "100 Test St"
    }
  ]
}

user.retrieveId

Description: The user.retrieveId webhook contains details about when a user's ID number (SSN, ITIN, etc.) is retrieved, either via API or SST.
Triggers:
- Successful API call to the Retrieve ID Number endpoint.
- Accessed via the appropriate SST role. If accessed via SST, the userID of the user who retrieved the ID number will be included.

{
  "uuid": "3d94c9c3-9eb2-4c41-8e16-c617de62703b",
  "companyId": "6823a83c643d753f0f79a7ec",
  "requestId": "f686284796705f5f25e894057dadda74",
  "responseBody": {
    "spidrActionId": "68950970e754b689d02d1350"
  },
  "spidrActionId": "68950970e754b689d02d1350",
  "userId": "68950761e754b589d02d112c",
  "webhookType": "user.retrieveId",
  "actionRequestor": {
    "source": "user",
    "userId": "670ec214b10b6cd94b8f83eb",
    "userIdSource": "internal"
  }
}

user.retrieveIdHistory

Description: The user.retrieveIdHistory webhook contains details about when a user's ID number (SSN, ITIN, etc.) history is retrieved, either via API or SST.
Triggers:
- Successful API call to the Retrieve ID Number History endpoint.
- Accessed via the appropriate SST role. If accessed via SST, the userID of the user who retrieved the ID number history will be included.

{
  "uuid": "c59e4f2f-f952-4983-a957-cd5c289eba73",
  "companyId": "6823a83c643d753f0f79a8ea",
  "requestId": "da2d54699e8f0174e834914a6b757c78",
  "spidrActionId": "68a8c77c17931956dc4c0f06",
  "userId": "68a8aa3517931956dc4c0e29",
  "webhookType": "user.retrieveIdHistory",
  "actionRequestor": {
    "source": "user",
    "userId": "670ec214b10b6cd94b8f43ea",
    "userIdSource": "internal"
  }
}

user.archive

Description: The user.archive webhook contains details about when a user is archived (either via API or SST).
Triggers:
- Successful API call to the Archive User endpoint.
- Archived via the appropriate SST role. If archived via SST, the userID and userEmail of the user who performed the archival will be included.

{
  "uuid": "8618d099-2b6b-4bdb-9611-9ea78da60d73",
  "companyId": "6823a83c643d753f0f89a8ec",
  "requestId": "4e6e746f73830b07d828754a7ea7d951",
  "responseBody": {
    "updated": true,
    "spidrActionId": "687eb3d82e438b1a7950a49c"
  },
  "spidrActionId": "687eb3d82e438b1a7950a49c",
  "userId": "687eb2f62e439b1a7950a47f",
  "webhookType": "user.archive",
  "actionRequestor": {
    "source": "api"
  },
  "archiveReason": "fraud"
}

User Endpoints that Support ZTM Risk Checks

🕷️
ZTM checks
ZTM risk data will be returned in webhook payloads if your program is configured for ZTM and risk checks are ran for the given endpoint call (bypassZtm = false).
A list of 'User' endpoints that support ZTM checks are listed below, as well as an example payload with ZTM risk data included.

Endpoint that supports ZTM checks	Corresponding Webhook(s)
Create User	user.create
Edit User	user.edit

Example User Webhook with ZTM Payload Included:

{
  "uuid": "74e95a6b-c28d-4d4e-a64d-8d3a287a6674",
  "companyId": "6823a83c643d753f0f79a9ec",
  "requestId": "655e22211d1c924d5f4b4632eb7e3420",
  "responseBody": {
    "id": "687eb1f62e439b1a7950a47f",
    "cip": {
      "status": "pass",
    },
    "ztmData": {
      "isTrainingMode": true,
      "riskLevel": "low",
      "providerSummary": {
        "riskLevel": "low",
        "riskConfigurationId": "nyGrZSlprJm8u6Cg",
        "providerLevels": [
          {
            "provider": "sardine",
            "riskLevel": "low"
          }
        ],
        "workflowExecutionId": "2951"
      },
      "providerResponses": [
        {
          "provider": "sardine",
          "level": "low",
          "sessionKey": "b280c1649770b57261d8847ec451ad6febbc",
          "flowId": "ada39609-c49c-419c-a916-b72a4b15fabe",
          "flowName": "flow-user-create",
          "flowType": "onboarding",
          "customer": {
            "score": 0,
            "level": "low",
            "rules": []
          },
          "providerData": {
            "sessionKey": "b280c1749660b57261d8847ec451ad6febbc",
            "level": "low",
            "status": "Success",
            "customer": {
              "score": 0,
              "level": "low",
              "reasonCodes": ["AL4", "AL5", "AL9"],
              "signals": [
                {
                  "key": "addressRiskLevel",
                  "value": "unknown",
                  "reasonCodes": ["AL4", "AL5", "AL9"]
                },
                {
                  "key": "emailDomainLevel",
                  "value": "unknown"
                },
                {
                  "key": "emailLevel",
                  "value": "unknown"
                },
                {
                  "key": "pepLevel",
                  "value": "low"
                },
                {
                  "key": "phoneLevel",
                  "value": "unknown"
                },
                {
                  "key": "sanctionLevel",
                  "value": "low"
                }
              ],
              "address": {
                "validity": "invalid"
              }
            },
            "checkpoints": {
              "customer": {
                "riskLevel": {
                  "value": "low",
                  "ruleIds": null
                }
              },
              "onboarding": {
                "riskLevel": {
                  "value": "low",
                  "ruleIds": null
                }
              }
            },
            "checkpointData": [
              {
                "name": "customer",
                "type": "weighted_max"
              },
              {
                "name": "onboarding",
                "type": "weighted_max"
              }
            ]
          }
        }
      ],
      "providerErrors": []
    },
    "spidrActionId": "687eb2f62e439b1a7951a480"
  },
  "spidrActionId": "687eb2f62e439b1a7951a480",
  "userId": "687eb2f62e439b1a7950a48f",
  "productId": "6823a83e59a0f48f78797c29",
  "webhookType": "user.create",
  "actionRequestor": {
    "source": "api"
  }
}