> For the complete documentation index, see [llms.txt](https://detected.gitbook.io/detected-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://detected.gitbook.io/detected-docs/api-overview/webhooks/profile-webhook-spec.md).

# Profile Webhook Spec

Used for notifications on the profile lifecycle within the platform.

## Webhook Payload

The payload of the webhook provides the following information in JSON format:

| Attribute           | Description                                                                                        |
| ------------------- | -------------------------------------------------------------------------------------------------- |
| event               | The type of event related to the webhook                                                           |
| id                  | the unique internal reference of the profile                                                       |
| customer\_reference | the unique customer assigned reference for the profile                                             |
| created\_at         | The date/time the profile was first created                                                        |
| updated\_at         | The date/time of when the profile was last updated                                                 |
| review\_status      | The status of the profile                                                                          |
| risk                | The risk score assigned to the profile (please note this is not the automatically generated score) |
| assignee            | The name of the user assigned to the profile                                                       |
| team                | Information on the team assigned to the profile                                                    |

## Events, Triggers & Profile Status

### Events

| **event**       | **What causes it**                                              |
| --------------- | --------------------------------------------------------------- |
| profile.created | New profile created (`POST /profiles`, Case Management, portal) |
| profile.updated | Status change, auto lifecycle, or metadata change               |

### Triggers

| **Trigger**                                                 | **Event**       |
| ----------------------------------------------------------- | --------------- |
| Profile created (API, Case management or Onboarding Portal) | profile.created |
| Case moves to Processed                                     | profile.updated |
| Customer submits KYB profile                                | profile.updated |
| Customer completes KYC (when profile type = individual)     | profile.updated |
| More information requested on a profile                     | profile.updated |
| Analyst changes profile status                              | profile.updated |
| Profile status changed by external API                      | profile.updated |

### Profile Status Lifecycle

```mermaid
flowchart LR
  Incomplete --> Processed --> NeedsReview["Needs Review"]
  NeedsReview --> AdditionalInfo["Additional Info Required"]
  NeedsReview --> Approved
  NeedsReview --> Declined
  AdditionalInfo --> NeedsReview
  Approved --> Archived
  Declined --> Archived
```

| **Status**                         | **Meaning**                                                         |
| ---------------------------------- | ------------------------------------------------------------------- |
| **Incomplete**                     | Case being created                                                  |
| **Processed**                      | Backend processing complete; portal open, not yet submitted         |
| **Needs Review**                   | Customer submitted onboarding                                       |
| **Additional Info Required**       | More information requested; profile.updated on change and re-submit |
| **Approved / Declined / Archived** | Compliance or workflow outcome                                      |

## Examples

```json
{
  "event": "profile.created",
  "timestamp": "2024-12-15T18:44:40.313335Z",
  "data": {
    "id": "09848a71-4219-4b68-85e1-c59c2eacf762",
    "customer_reference": "andre22",
    "risk": {
      "id": "05364241-6843-401d-9283-532fb4350b4f",
      "label": "P2 review required",
      "category": "Medium"
    },
    "team": {
      "id": 55,
      "label": "The A Team - edited (Compliance)"
    },
    "configuration": null,
    "review_status": "Processed",
    "assignee": {
      "id": "auth0|60dc8a229d13ba006c5d51ab",
      "name": "Lauren Sipple"
    },
    "review_at": null,
    "updated_at": "2024-12-15 18:20:10",
    "created_at": "2023-05-05 14:47:20"
  }
}
```

## Verify portal events

There is an option to also receive specific events and data related to the verify portal, these can be useful for certain integrations that rely on realtime updates to KYC profiles. More information on the verify events that can be triggered is available here: [Verify Events](/detected-docs/api-overview/webhooks/profile-webhook-spec/verify-events.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://detected.gitbook.io/detected-docs/api-overview/webhooks/profile-webhook-spec.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.