Webhooks
The CFX Platform publishes events to registered B2B partners to ensure they are informed of transactions and core data changes as they occur on the CFX Network. Registration of webhook endpoints, with appropriate security and authentication, is performed at partner onboarding.
This page details the common webhook events which are published to B2B partners.
Domain | Events |
|---|---|
Identity | Identity Registered |
Organization | Organization Registered |
Deposit | Deposit Status Update |
Withdrawal | Withdrawal Status Update |
Transfer | Transfer Status Updated |
Swap | Swap Status Updated |
Rewards | Reward Created |
Identity
Identity Registered
| Event | Description |
|---|---|
| identity.identity.registered | A CFX identity has been registered. The generated identity ID and initial status values will be returned within this event. Broader identity details can be retrieved through the identity API endpoint. |
Example payload
{
"event": "identity.identity.registered",
"customerId": "1",
"identityId": "id_GIjI8e2rj77FR4uemj57W",
"data": {
"customerName": "MoveMoney",
"countryOfResidence": "US",
"email": "[email protected]",
"phone": "+13339882440",
"idvLevel": "FULL_PLUS",
"status": "ACTIVE"
},
"createdAt": "2024-06-03T05:10:53.451Z"
}Schema
{
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "Type of event published",
"example": "identity.identity.statusUpdated",
},
"customerId": {
"type": "string",
"description": "Unique identifier for a CFX customer used to route events to the customer webhook endpoints.",
"example": "31",
},
"identityId": {
"type": "string",
"description": "Unique identifier for the CFX identity",
"example": "id_HC7yTQVgxM7C6YWno7ju3",
},
"data": {
"type": "object",
"properties": {
"customerName": {
"type": "string",
"description": "The name of the CFX customer the identity is associated with",
"example": "MoveMoney",
},
"countryofResidence": {
"type": "string",
"description": "The identity's country of residence",
"example": "US",
},
"email": {
"type": "string",
"description": "Email associated with the identity",
"example": "[email protected]",
},
"phone": {
"type": "string",
"description": "The phone number associated with the identity",
"example": "+1555123456",
},
"idvLevel": {
"type": "string",
"description": "Current identity verification level",
"example": "FULL_PLUS",
},
"status": {
"type": "string",
"description": "Status of the identity",
"example": "ACTIVE",
},
},
},
"createdAt": {
"type": "string",
"description": "Datetime the event was created",
"example": "2023-10-23T06:20:04.366+00:00",
},
},
}
}Identity Status Updated
| Event | Description |
|---|---|
| identity.identity.statusUpdated | The status of a CFX identity has been updated. The identity ID and new status will be published as an event. The Retrieve Identity endpoint can be subsequently invoked if required to retrieve the updated identity data. |
Example payload
{
"event": "identity.identity.statusUpdated",
"customerId": "1",
"identityId": "id_SkNo0yyGRWNjc9raEIMhf",
"data": {
"status": "ACTIVE"
},
"createdAt": "2024-03-26T03:42:12.080Z"
}Schema
{
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "Type of event published",
"example": "identity.identity.statusUpdated",
},
"customerId": {
"type": "string",
"description": "Unique identifier for a CFX customer used to route events to the customer webhook endpoints.",
"example": "31",
},
"identityId": {
"type": "string",
"description": "Unique identifier for the CFX identity",
"example": "id_HC7yTQVgxM7C6YWno7ju3",
},
"createdAt": {
"type": "string",
"description": "Datetime the event was created",
"example": "2023-10-23T06:20:04.366+00:00",
},
"data": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The updated status for the identity",
"example": "ACTIVE",
}
},
},
},
}
}status
status| Status | Description |
|---|---|
| ACTIVE | The identity is active and can transact according their active IDV level. |
| REQUIRES_IDV | The identity needs to perform identity verification. The identity will not be activated until IDV has successfully completed. The identity can automatically transition from this state to ACTIVE after a successful IDV submission. |
| REQUIRES_REVIEW | The identity has been flagged for manual review. The identity can only transition to another state through a manual review process by CFX operators. |
Identity Verification Status Updated
| Event | Description |
|---|---|
| identity.identityVerification.statusUpdated | The status of an Identity Verification (IDV) has been updated. This typically is triggered as the identity progresses through an identity verification process. Broader details can subsequently be retrieved through the Identity API endpoints. |
Example payload
{
"event": "identity.identityVerification.statusUpdated",
"customerId": "31",
"identityId": "id_f655aojaGtqKmFcNxelhX",
"data": {
"idvId": "idv_4qXgcfZnFZXreX",
"status": "SUCCESS",
"idvLevel": "FULL"
},
"createdAt": "2024-03-22T01:32:22.853Z"
}Schema
{
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "Type of event published",
"example": "identity.identityVerification.statusUpdated",
},
"customerId": {
"type": "string",
"description": "Unique identifier for a CFX customer used to route events to the customer webhook endpoints.",
"example": "31",
},
"identityId": {
"type": "string",
"description": "Unique identifier for the CFX identity",
"example": "id_HC7yTQVgxM7C6YWno7ju3",
},
"createdAt": {
"type": "string",
"description": "Datetime the event was created",
"example": "2023-10-23T06:20:04.366+00:00",
},
"data": {
"type": "object",
"properties": {
"idvId": {
"type": "string",
"description": "Unique identifier for an identity verification process",
"example": "ACTIVE",
},
"status": {
"type": "string",
"description": "The status of the IDV process",
"example": "SUCCESS",
},
"idvLevel": {
"type": "string",
"description": "The identity verification level for the identity",
"example": "FULL",
}
},
},
},
}
}status
status| Status | Description |
|---|---|
| ACTIVE | The identity verification process is active. Note this is the status of the IDV process (ie the process is active) rather than the resulting identity status. An event of this status will be published should an identity retry a failed identity verification process. |
| SUCCESS | The identity verification process has been completed successfully. |
| FAILED | The identity verification process has failed. |
idvLevel
idvLevel| Status | Description |
|---|---|
| NONE | Identity has not completed any level of identity verification |
| FULL | Identity has successfully completed our base identity verification Template |
| FULL_PLUS | Identity has successfully completed our "PLUS" version of identity verification which requires a selfie check on top of our existing template. |
Organization
Organization Registered
| Event | Description |
|---|---|
| organization.organization.created | Each B2B customer can register both Identities and Organizations, which map to individuals and commercial entities. This webhook is delivered when an organization has been successfully created. |
Example payload
{
"event": "organization.organization.created",
"customerId": "cust_QHiAPDHYkKi1S0HejBIQ4",
"data": {
"id": "org_osCcdRj9fkoOkjil1Yf5zg",
"status": "ACTIVE"
},
"createdAt": "2025-04-01T19:53:44.291Z"
}Schema
{
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "Type of event published",
"example": "organization.organization.created"
},
"customerId": {
"type": "string",
"description": "Unique identifier for a CFX customer used to route events to the customer webhook endpoints.",
"example": "cust_QHiAPDHYkKi1S0HejBIQ4"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the organization",
"example": "org_osCcdRj9fkoOkjil1Yf5zg"
},
"status": {
"type": "string",
"description": "Status of the organization",
"example": "ACTIVE"
}
},
"required": ["id", "status"]
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Datetime the event was created",
"example": "2025-04-01T19:53:44.291Z"
}
},
"required": ["event", "customerId", "data", "createdAt"]
}
Organization Status Updated
| Event | Description |
|---|---|
| organization.organization.statusUpdated | The status of a previously created Organization has been updated. |
Example payload
{
"event": "organization.organization.created",
"customerId": "cust_QHiAPDHYkKi1S0HejBIQ4",
"data": {
"id": "org_osCcdRj9fkoOkjil1Yf5zg",
"status": "ACTIVE"
},
"createdAt": "2025-04-01T19:53:44.291Z"
}Schema
{
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "Type of event published",
"example": "organization.organization.created"
},
"customerId": {
"type": "string",
"description": "Unique identifier for a CFX customer used to route events to the customer webhook endpoints.",
"example": "cust_QHiAPDHYkKi1S0HejBIQ4"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the organization",
"example": "org_osCcdRj9fkoOkjil1Yf5zg"
},
"status": {
"type": "string",
"description": "Status of the organization",
"example": "ACTIVE"
}
},
"required": ["id", "status"]
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Datetime the event was created",
"example": "2025-04-01T19:53:44.291Z"
}
},
"required": ["event", "customerId", "data", "createdAt"]
}
Deposit
Deposit Status Updated
| Event | Description |
|---|---|
| deposit.deposit.statusUpdated | The status of a CFX deposit has been updated. The deposit status will evolve as the deposit progresses through the supporting workflows. Broader details can subsequently be retrieved through the Deposit API endpoints. |
Example payload
{
"event": "deposit.cardRequest.statusUpdated",
"customerId": "31",
"identityId": "id_OkvdoYHp0mHPsYIWQ1r2D",
"data": {
"cardDepositRequestId": "crddprq_VtrUsD1toDgnhnhkWmmsE",
"status": "CREATED"
},
"createdAt": "2024-03-23T03:43:27.397Z"
}Schema
{
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "Type of event published",
"example": "deposit.cardRequest.statusUpdated",
},
"customerId": {
"type": "string",
"description": "Unique identifier for a CFX customer used to route events to the customer webhook endpoints.",
"example": "31",
},
"identityId": {
"type": "string",
"description": "Unique identifier for the CFX identity",
"example": "id_HC7yTQVgxM7C6YWno7ju3",
},
"createdAt": {
"type": "string",
"description": "Datetime the event was created",
"example": "2023-10-23T06:20:04.366+00:00",
},
"data": {
"type": "object",
"properties": {
"cardDepositRequestId": {
"type": "string",
"description": "Unique identifier for a card deposit",
"example": "crddprq_VtrUsD1toDgnhnhkWmmsE",
},
"status": {
"type": "string",
"description": "The status of the card deposit",
"example": "CREATED",
}
},
},
},
}
}status
status| Status | Description |
|---|---|
| PENDING | The deposit has been initiated but requires further processing before it can be processed. |
| CANCELLED | The deposit has been cancelled by the identity or CFX. |
| PROCESSING | The identity has completed the deposit and the workflow is processing. |
| DEPOSITED | The deposit workflow has completed successfully. |
type
type| Status | Description |
|---|---|
| CARD | Deposit funded by card. |
| CASH | Deposit funded by cash at a physical retailer. |
| CRYPTO | Deposit funded by crypto (eg USDC). |
Crypto Deposit Status Updated
| Event | Description |
|---|---|
| deposit.cryptoRequest.statusUpdated | The CFX Platform manages a state machine which orchestrates the states associated with deposits via cryptocurrency. These events are published as a user attempts to deposit into the CFX Network via cryptocurrency. |
Example payload
{
"event": "deposit.cryptoRequest.statusUpdated",
"customerId": "31",
"identityId": "id_OkvdoYHp0mHPsYIWQ1r2D",
"data": {
"cryptoDepositRequestId": "crydprq_brKxIPqwUb97nAibMqS5A",
"cryptoDepositRequestReference": "97bdce2f-28f2-4edb-a1e5-46486cd77272",
"status": "CREATED"
},
"createdAt": "2024-03-23T03:43:27.397Z"
}Schema
{
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "Type of event published",
"example": "deposit.cryptoRequest.statusUpdated",
},
"customerId": {
"type": "string",
"description": "Unique identifier for a CFX customer used to route events to the customer webhook endpoints.",
"example": "31",
},
"identityId": {
"type": "string",
"description": "Unique identifier for the CFX identity",
"example": "id_HC7yTQVgxM7C6YWno7ju3",
},
"createdAt": {
"type": "string",
"description": "Datetime the event was created",
"example": "2023-10-23T06:20:04.366+00:00",
},
"data": {
"type": "object",
"properties": {
"cryptoDepositRequestId": {
"type": "string",
"description": "Unique identifier for a crypto deposit",
"example": "crydprq_brKxIPqwUb97nAibMqS5A",
},
"cryptoDepositRequestReference": {
"type": "string",
"description": "Reference provided for the crypto deposit",
"example": "97bdce2f-28f2-4edb-a1e5-46486cd77272",
},
"status": {
"type": "string",
"description": "The status of the crypto deposit",
"example": "CREATED",
}
},
},
},
}
}status
status| Status | Description |
|---|---|
| CREATED | Crypto deposit workflow has been created |
| PENDING | Crypto deposit in flight and pending finalizaition |
| SUCCEEDED | Crypto deposit successfully completed |
| FAILED | Crypto deposit has failed |
| EXPIRED | Crypto deposit request has now expired and can no longer be completed |
| CANCELLED | Crypto deposit workflow has been cancelled |
US Wire Deposit Status Updated
| Event | Description |
|---|---|
| deposit.usWireRequest.statusUpdated | The CFX Platform manages a state machine which orchestrates the states associated with deposits via US wires. These events are published as a user attempts to deposit funds into the CFX Network via US wires. |
Example payload
{
"event": "deposit.usWireRequest.statusUpdated",
"customerId": "31",
"identityId": "id_OkvdoYHp0mHPsYIWQ1r2D",
"data": {
"usWireDepositRequestId": "uswrdprq_vwdPwuE3qTHUJjGdwnW3l",
"usWireDepositRequestReference": "183733",
"status": "CREATED"
},
"createdAt": "2024-03-23T03:43:27.397Z"
}Schema
{
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "Type of event published",
"example": "deposit.usWireRequest.statusUpdated",
},
"customerId": {
"type": "string",
"description": "Unique identifier for a CFX customer used to route events to the customer webhook endpoints.",
"example": "31",
},
"identityId": {
"type": "string",
"description": "Unique identifier for the CFX identity",
"example": "id_HC7yTQVgxM7C6YWno7ju3",
},
"createdAt": {
"type": "string",
"description": "Datetime the event was created",
"example": "2023-10-23T06:20:04.366+00:00",
},
"data": {
"type": "object",
"properties": {
"usWireDepositRequestId": {
"type": "string",
"description": "Unique identifier for a US wire deposit",
"example": "uswrdprq_vwdPwuE3qTHUJjGdwnW3l",
},
"usWireDepositRequestReference": {
"type": "string",
"description": "Reference provided for the US wire deposit",
"example": "183733",
},
"status": {
"type": "string",
"description": "The status of the US wire deposit",
"example": "CREATED",
}
},
},
},
}
}status
status| Status | Description |
|---|---|
| CREATED | Crypto deposit workflow has been created |
| PENDING | Crypto deposit in flight and pending finalizaition |
| SUCCEEDED | Crypto deposit successfully completed |
| FAILED | Crypto deposit has failed |
| EXPIRED | Crypto deposit request has now expired and can no longer be completed |
| CANCELLED | Crypto deposit workflow has been cancelled |
Withdrawals
Withdrawal Status Update
| Event | Description |
|---|---|
| withdrawal.withdrawal.statusUpdated | CFX withdrawals pass through a series of states before completion. This event publishes updates to the withdrawal status. Broader details can subsequently be retrieved through the Withdrawal API endpoints. |
Example payload
{
"event": "withdrawal.withdrawal.statusUpdated",
"customerId": "31",
"identityId": "id_Ys8pWRrVuIQ5LPxxLdR2G",
"data": {
"withdrawalId": "wd_1rx0PtcAk99decgGF7JTT2",
"status": "COMPLETED",
"type": "US_ACH"
},
"createdAt": "2024-03-27T02:00:03.124Z"
}Schema
{
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "Type of event published",
"example": "withdrawal.withdrawal.statusUpdated",
},
"customerId": {
"type": "string",
"description": "Unique identifier for a CFX customer used to route events to the customer webhook endpoints.",
"example": "31",
},
"identityId": {
"type": "string",
"description": "Unique identifier for the CFX identity",
"example": "id_Ys8pWRrVuIQ5LPxxLdR2G",
},
"createdAt": {
"type": "string",
"description": "Datetime the event was created",
"example": "2023-10-23T06:20:04.366+00:00",
},
"data": {
"type": "object",
"properties": {
"withdrawalId": {
"type": "string",
"description": "Unique identifier for a CFX withdrawal",
"example": "wd_1rx0PtcAk99decgGF7JTT2",
},
"status": {
"type": "string",
"description": "The status of the card deposit",
"example": "COMPLETED",
},
"type": {
"type": "string",
"description": "The type of withdrawal requested",
"example": "US_ACH",
}
},
},
},
}
}status
status| Status | Description |
|---|---|
| PENDING | The withdrawal has been initiated but requires further processing before it can be processed. |
| COMPLETED | The withdrawal has completed successfully. |
| FAILED | The withdrawal has failed. This can be due to issues with the target bank account or unexpected system issues. |
| RETURNED | The withdrawal could not be completed and the funds have been returned to the user wallet. |
type
type| Status | Description |
|---|---|
| US_ACH | Withdrawal to US bank account |
| MX_SPEI | Withdrawal to a Mexican bank account |
Transfer
Transfer Status Updated
| Event | Description |
|---|---|
| redemption.transfer.statusUpdated | Transfers move funds between nominated CFX accounts / wallets. The status of transfers will be exposed through this event. |
Example payload
{
"event": "redemption.transfer.statusUpdated",
"customerId": "cust_ktzQkOpddau1aw5Oqo0wdMX",
"data": {
"id": "redtfr_rTRbLj3DrUwcgIjOYsNUH",
"status": "PENDING"
},
"organizationId": "org_NFGjO995V9T8E7CUaynSk",
"organizationReferenceId": "248885051499",
"createdAt": "2025-04-01T03:46:20.710Z"
}Schema
{
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "Type of event published",
"example": "redemption.transfer.statusUpdated"
},
"customerId": {
"type": "string",
"description": "Unique identifier for a CFX customer used to route events to the customer webhook endpoints.",
"example": "cust_ktzQkOpddau1aw5Oqo0wdMX"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the redemption transfer",
"example": "redtfr_rTRbLj3DrUwcgIjOYsNUH"
},
"status": {
"type": "string",
"description": "Current status of the redemption transfer",
"example": "PENDING"
}
},
"required": ["id", "status"]
},
"organizationId": {
"type": "string",
"description": "Unique identifier for the organization associated with the redemption transfer",
"example": "org_NFGjO995V9T8E7CUaynSk"
},
"organizationReferenceId": {
"type": "string",
"description": "External reference identifier provided by the organization",
"example": "28653051499"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Datetime the event was created",
"example": "2025-04-01T03:46:20.710Z"
}
},
"required": ["event", "customerId", "data", "organizationId", "organizationReferenceId", "createdAt"]
}
Swap
Swap Status Updated
| Event | Description |
|---|---|
| swap.swap.statusUpdated | Swaps facilitate the exchange of supported tokens on the CFX Network. This event is delivered to provide status updates on these swaps as they execute on the blockchain. |
Example payload
{
"event": "swap.swap.statusUpdated",
"customerId": "cust_ktzQkOpddau1aw5Oqo0wdMX",
"data": {
"id": "swp_lOeJjK99j8ZlCDeFeECAno",
"status": "COMPLETED"
},
"identityId": "id_R1JgKCjUiuu7EierKIczMD",
"identityReferenceId": "+17082326657",
"createdAt": "2025-03-31T23:15:54.176Z"
}The swap events may be populated with additional fee details should they be relevant to the transaction.
Schema
{
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "Type of event published",
"example": "swap.swap.statusUpdated"
},
"customerId": {
"type": "string",
"description": "Unique identifier for a CFX customer used to route events to the customer webhook endpoints.",
"example": "cust_ktzQkOpddau1aw5Oqo0wdMX"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the swap transaction",
"example": "swp_lOeJjK99j8ZlCDeFeECAno"
},
"status": {
"type": "string",
"description": "Current status of the swap transaction",
"example": "COMPLETED"
}
},
"required": ["id", "status"]
},
"identityId": {
"type": "string",
"description": "Unique identifier for the identity associated with the swap",
"example": "id_R1JgKCjUiuu7EierKIczMD"
},
"identityReferenceId": {
"type": "string",
"description": "External reference identifier for the identity, such as a phone number or internal ID",
"example": "+17082326657"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Datetime the event was created",
"example": "2025-03-31T23:15:54.176Z"
}
},
"required": ["event", "customerId", "data", "identityId", "identityReferenceId", "createdAt"]
}
Rewards
Reward Created
| Event | Description |
|---|---|
| reward.reward.created | The CFX Platform has a rewards engine which allows customers to issue rewards to identities. Depending on the program configuration, rewards can be swapped into the MOVEUSD stablecoin (USD) for subsequent withdrawal or into other supported cryptocurrencies. This event is fired when a reward has been created. |
Example payload
{
"event": "reward.reward.created",
"customerId": "cust_ktzQkOpddau1aw5Oqo0wdMX",
"data": {
"id": "rew_KXyQj8IIdXaCbBj8f27UI",
"transactionType": "CREDIT",
"amount": {
"amount": 5.00,
"currency": "MOVEUSD"
},
"phone": "+1xxxxxxxx",
"idempotencyKey": "rewclaim_XTFfkI2ddFLCyXQG1z4Ne",
"category": "signup",
"note": "Signup bonus",
"createdAt": "2025-04-01T17:36:25.780Z"
},
"createdAt": "2025-04-01T17:36:25.864Z"
}Schema
{
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "Type of event published",
"example": "reward.reward.created"
},
"customerId": {
"type": "string",
"description": "Unique identifier for a CFX customer used to route events to the customer webhook endpoints.",
"example": "cust_ktzQkOpddau1aw5Oqo0wdMX"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the reward",
"example": "rew_KXyQj8IIdXaCbBj8f27UI"
},
"transactionType": {
"type": "string",
"description": "Type of transaction for the reward (e.g., CREDIT or DEBIT)",
"example": "CREDIT"
},
"amount": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"description": "The numerical value of the reward",
"example": 5.00
},
"currency": {
"type": "string",
"description": "The currency of the reward amount",
"example": "MOVEUSD"
}
},
"required": ["amount", "currency"]
},
"phone": {
"type": "string",
"description": "Phone number associated with the recipient of the reward",
"example": "+1xxxxxxxx"
},
"idempotencyKey": {
"type": "string",
"description": "Unique key to ensure idempotent reward creation",
"example": "rewclaim_XTFfkI2ddFLCyXQG1z4Ne"
},
"category": {
"type": "string",
"description": "Category or reason for the reward",
"example": "signup"
},
"note": {
"type": "string",
"description": "Optional note or message about the reward",
"example": "Signup bonus"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Datetime the reward was created",
"example": "2025-04-01T17:36:25.780Z"
}
},
"required": ["id", "transactionType", "amount", "phone", "idempotencyKey", "category", "note", "createdAt"]
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Datetime the event was created",
"example": "2025-04-01T17:36:25.864Z"
}
},
"required": ["event", "customerId", "data", "createdAt"]
}
Reward Claimed
| Event | Description |
|---|---|
| reward.reward.claimed | This event is delivered when an identity claims rewards. Claims results in a debit to the identities reward balance whist crediting their wallet with MOVEUSD stablecoin. |
Example payload
{
"event": "reward.reward.claimed",
"customerId": "cust_ktzQkOpddau1aw5Oqo0wdMX",
"data": {
"id": "rewclaim_XTFfz3EvkshhEXQG1z4Ne",
"status": "CLAIMED",
"reward": {
"amount": {
"amount": 50.00,
"currency": "MOVEUSD"
}
}
},
"identityId": "id_qSYoAj8U22jnvGk2AdbAy",
"identityReferenceId": "+14044095321",
"createdAt": "2025-04-01T17:36:28.221Z"
}Schema
{
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "Type of event published",
"example": "reward.reward.claimed"
},
"customerId": {
"type": "string",
"description": "Unique identifier for a CFX customer used to route events to the customer webhook endpoints.",
"example": "cust_ktzQkOpddau1aw5Oqo0wdMX"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the reward claim",
"example": "rewclaim_XTFfz3EvkshhEXQG1z4Ne"
},
"status": {
"type": "string",
"description": "Current status of the reward claim",
"example": "CLAIMED"
},
"reward": {
"type": "object",
"properties": {
"amount": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"description": "The amount of the claimed reward",
"example": 50.00
},
"currency": {
"type": "string",
"description": "The currency of the reward",
"example": "MOVEUSD"
}
},
"required": ["amount", "currency"]
}
},
"required": ["amount"]
}
},
"required": ["id", "status", "reward"]
},
"identityId": {
"type": "string",
"description": "Unique identifier for the identity associated with the reward claim",
"example": "id_qSYoAj8U22jnvGk2AdbAy"
},
"identityReferenceId": {
"type": "string",
"description": "External reference identifier for the identity, such as a phone number or internal ID",
"example": "+14044095321"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Datetime the event was created",
"example": "2025-04-01T17:36:28.221Z"
}
},
"required": ["event", "customerId", "data", "identityId", "identityReferenceId", "createdAt"]
}
Updated 1 day ago