Waves

Waves is a real-time fraud detection system that uses machine learning to detect and prevent fraud. It is a powerful tool that can help you protect your business from fraudsters. Waves uses a combination of machine learning algorithms and human expertise to detect and prevent fraud in real-time. It can help you identify fraudulent transactions, detect suspicious activity, and prevent fraud before it happens.

GET/v1/waves?correspondentId={correspondentId}&page={page}&limit={limit}

Get Waves

Use this endpoint to retrieve the Wave events for the correspondent.

Path Parameters

Parameter	Description	Type	Input
`correspondentId`	Unique ID for the correspondent	UUID	Required
`page`	Page number	Number	Optional
`limit`	Number of items per page	Number	Optional

Success Response

JSON

200 OK

{
    "waves": [
{
    "createdAt": "2024-04-27T12:39:56.175Z",
    "updatedAt": "2024-04-27T12:39:56.175Z",
    "entryId": "24f1c21f-3ad2-45b3-81c7-6162ee626066",
    "customerId": "8ec55833-e62d-4fad-bab7-84efa5e01973",
    "type": "ACCOUNT",
    "decision": "BLOCKED",
    "payload": "{\"customerId\":\"8ec55833-e62d-4fad-bab7-84efa5e01973\",\"correspondentId\":" +
    "\"e36363d8-a472-47f6-b0c3-faccd1cec996\",\"displayId\":\"70B2C243B\",\"portfolioType\":\"MARGIN\"," +
    "\"accountType\":\"ROTH_IRA\",\"registeredRepReview\":{\"registeredRepName\":\"Rep Name\",\"registeredRepId\":" +
    "\"ef89e384-729d-4bc3-9b49-135fdea6f87a\",\"outcome\":\"REVIEW\"},\"dateOfBirth\":\"1997-09-09T05:00:00.000Z\"," +
    "\"email\":\"spiritfingers@gmail.com\",\"firstName\":\"Spir\",\"lastName\":\"Fingers\",\"maritalStatus\":\"MARRIED\"," +
    "\"citizenshipCountry\":\"USA\",\"taxResidencyCountry\":\"USA\",\"taxId\":\"873147096\",\"taxIdType\":\"USA_SSN\",\"phoneNumber\":\"2237458596\",\"homeAddress\":" +
    "{\"city\":\"Houston\",\"line1\":\"233 Jinx St\",\"state\":\"TX\",\"zip\":\"77058\",\"line2\":null},\"mailingAddress\":" +
    "{\"city\":\"Houston\",\"line1\":\"233 Jinx St\",\"state\":\"TX\",\"zip\":\"77058\",\"line2\":null},\"disclosures\":" +
    "{\"politicallyExposedPerson\":false,\"associatedPerson\":false,\"publicCompanyControlPerson\":false," +
    "\"publicCompanySymbol\":\"\",\"associatedPersonEmployer\":\"\",\"sendDuplicateStatements\":false,\"sendDuplicateConfirmations\":false," +
    "\"correspondentEmployee\":false,\"sendDuplicateStatementsEmails\":\"\",\"sendDuplicateConfirmationsEmails\":\"\"}," +
    "\"employment\":{\"status\":\"SELF_EMPLOYED\",\"employer\":null,\"employerAddress\":{\"zip\":null,\"city\":null," +
    "\"line1\":null,\"line2\":null,\"state\":null}},\"investmentProfile\":{\"annualIncome\":20000," +
    "\"investmentHorizonYears\":\"LONGEST\",\"investmentObjectives\":\"CAPITAL_PRESERVATION\",\"liquidNetWorth\":300000," +
    "\"liquidityNeeds\":\"SOMEWHAT_IMPORTANT\",\"netWorth\":250000,\"optionTransactionsPerYear\":36," +
    "\"riskTolerance\":\"MODERATE\",\"stockTransactionsPerYear\":30,\"federalTaxRate\":20,\"optionsTradingExperience\":\"NONE\"," +
    "\"stockTradingExperience\":\"LIMITED\"},\"backupWithholding\":false,\"gravityIdentityCheck\":false," +
    "\"ipAddress\":\"127.000.000.000\",\"status\":\"REJECTED\",\"message\":\"Customer with the same Social Security Number already exists\"," +
    "\"frozen\":false,\"group\":{\"createdAt\":\"2024-03-01T04:03:44.854Z\",\"updatedAt\":\"2024-03-01T04:03:44.854Z\"," +
    "\"groupId\":\"b79d91b9-13b6-4380-b2cd-534e9f40cdb4\",\"groupName\":\"default\"},\"middleName\":null,\"trustedContact\":{\"email\":null," +
    "\"phoneNumber\":null,\"lastName\":null,\"firstName\":null,\"middleName\":null},\"createdAt\":\"2024-03-02T23:54:57.609Z\"," +
    "\"updatedAt\":\"2024-03-02T23:54:57.609Z\"}"
},
{
    "createdAt": "2024-04-27T12:39:56.175Z",
    "updatedAt": "2024-04-27T12:39:56.175Z",
    "entryId": "620c1787-3f11-4bf9-850f-ec25ce860b63",
    "customerId": "d0cfc3c0-927a-4e05-a4f0-466420b13036",
    "type": "SOURCE",
    "decision": "BLOCKED",
    "payload": "{\"customerId\":\"d0cfc3c0-927a-4e05-a4f0-466420b13036\"," +
    "\"routingNumber\":\"1234569\",\"accountNumber\":\"87063095765080634\"," +
    "\"ownerName\":\"Jane Johnson\",\"accountType\":\"CHECKING\"," +
    "\"bankName\":\"Discover Bank\",\"fraudCheck\":true}"
}
    ],
    "meta": {
    "page": 1,
    "limit": 50,
    "total": 2,
    "hasMore": false
}
}

GET/v1/waves/{entryId}

Get Wave Event

Use this endpoint to retrieve a Wave event.

Path Parameters

Parameter	Description	Type	Input
`entryId`	Unique ID for the event	UUID	Required

Success Response

JSON

200 OK

{
    "createdAt": "2024-03-04T02:18:16.610Z",
    "updatedAt": "2024-03-04T02:18:16.610Z",
    "entryId": "620c1787-3f11-4bf9-850f-ec25ce860b63",
    "customerId": "d0cfc3c0-927a-4e05-a4f0-466420b13036",
    "type": "SOURCE",
    "decision": "BLOCKED",
    "payload": "{\"customerId\":\"d0cfc3c0-927a-4e05-a4f0-466420b13036\",
    \"routingNumber\":\"1234569\",\"accountNumber\":\"87063095765080634\",
    \"ownerName\":\"Jane Johnson\",\"accountType\":\"CHECKING\",
    \"bankName\":\"Discover Bank\",\"fraudCheck\":true}"
}