Skip to main content

Webhooks

Registration webhooks are sent to every agent with access to the assignor's registration (manager, consultant and assignor) that has a webhook configured. Registrations originated from a Fromtis load (fromtis_load) do not fire a webhook. Signature, resending and configuration: see Webhook Authentication.

Analysis Webhooks​

webhook_type: assignor_registry.analysis_status_change

Routed to Compliance​

STATUS
in_manual_analysis
Webhook Body
{
    "data":{
        "assignor_registry_key": "35ff6e5c-a3e7-4b04-a8be-6e49a3a906e4",
        "analysis_key": "41d6ff41-1dac-4df7-9e50-d15210ec57f3",
        "analysis_status": "in_manual_analysis",
        "reproval_reason": null,
        "reproval_details": null
    },
    "webhook_type":"assignor_registry.analysis_status_change",
    "webhook_datetime":"2025-01-22T20:30:23Z"
}

Under Document Review​

STATUS
pending_internal_validation
Webhook Body
{
    "data":{
        "assignor_registry_key": "35ff6e5c-a3e7-4b04-a8be-6e49a3a906e4",
        "analysis_key": "41d6ff41-1dac-4df7-9e50-d15210ec57f3",
        "analysis_status": "pending_internal_validation",
        "reproval_reason": null,
        "reproval_details": null
    },
    "webhook_type":"assignor_registry.analysis_status_change",
    "webhook_datetime":"2025-01-22T20:30:23Z"
}

Approved​

STATUS
approved
Webhook Body
{
    "data":{
        "assignor_registry_key": "35ff6e5c-a3e7-4b04-a8be-6e49a3a906e4",
        "analysis_key": "41d6ff41-1dac-4df7-9e50-d15210ec57f3",
        "analysis_status": "approved",
        "reproval_reason": null,
        "reproval_details": null
    },
    "webhook_type":"assignor_registry.analysis_status_change",
    "webhook_datetime":"2025-01-22T20:30:23Z"
}

Rejected​

STATUS
reproved
Webhook Body
{
    "data":{
        "assignor_registry_key": "35ff6e5c-a3e7-4b04-a8be-6e49a3a906e4",
        "analysis_key": "41d6ff41-1dac-4df7-9e50-d15210ec57f3",
        "analysis_status": "reproved",
        "reproval_reason": "insuficient_documents",
        "reproval_details": "Anexar procuração do sócio XXX.XXX.XXX-XX."
    },
    "webhook_type":"assignor_registry.analysis_status_change",
    "webhook_datetime":"2025-01-22T20:30:23Z"
}

Canceled​

STATUS
canceled

Fired when an analysis is canceled. The most common case is the automatic cancellation due to inactivity: an analysis that goes 1 month without activity — typically stuck in pending_documents, with no documents attached or without the analysis being triggered — is canceled by QI Tech.

The status is terminal. To resume the registration, generate a new analysis through the Registration Update.

Webhook Body
{
    "data":{
        "assignor_registry_key": "35ff6e5c-a3e7-4b04-a8be-6e49a3a906e4",
        "analysis_key": "41d6ff41-1dac-4df7-9e50-d15210ec57f3",
        "analysis_status": "canceled",
        "reproval_reason": null,
        "reproval_details": null
    },
    "webhook_type":"assignor_registry.analysis_status_change",
    "webhook_datetime":"2025-01-22T20:30:23Z"
}

Annotation Webhooks​

webhook_type: assignor_registry.annotation_status_change

Fired whenever a Compliance Annotation has its status changed. They are sent when the annotation is opened (open) and when it is answered (closed).

info

Annotations originated from a Fromtis load (fromtis_load) do not fire a webhook.

Annotation opened​

STATUS
open
Webhook Body
{
    "data":{
        "annotation_key": "1f2e3d4c-5b6a-4c8d-9e0f-1a2b3c4d5e6f",
        "analysis_key": "41d6ff41-1dac-4df7-9e50-d15210ec57f3",
        "assignor_registry_key": "35ff6e5c-a3e7-4b04-a8be-6e49a3a906e4",
        "annotation_status": "open",
        "message": "Anexar procuração do sócio XXX.XXX.XXX-XX."
    },
    "webhook_type":"assignor_registry.annotation_status_change",
    "webhook_datetime":"2025-01-22T20:30:23Z"
}

Annotation answered​

STATUS
closed
Webhook Body
{
    "data":{
        "annotation_key": "1f2e3d4c-5b6a-4c8d-9e0f-1a2b3c4d5e6f",
        "analysis_key": "41d6ff41-1dac-4df7-9e50-d15210ec57f3",
        "assignor_registry_key": "35ff6e5c-a3e7-4b04-a8be-6e49a3a906e4",
        "annotation_status": "closed",
        "message": "Anexar procuração do sócio XXX.XXX.XXX-XX."
    },
    "webhook_type":"assignor_registry.annotation_status_change",
    "webhook_datetime":"2025-01-22T20:30:23Z"
}

Registration Webhooks​

webhook_type: assignor_registry.assignor_registry_status_change. Sent only once, when the assignor becomes effective (registered).

Assignor activated​

STATUS
registered
Webhook Body
{
    "data":{
        "assignor_registry_key": "35ff6e5c-a3e7-4b04-a8be-6e49a3a906e4",
        "status": "registered"
    },
    "webhook_type":"assignor_registry.assignor_registry_status_change",
    "webhook_datetime":"2025-01-22T20:30:23Z"
}