Skip to main content
The CorsaClient exposes the following services:

Clients

Access via client.clients
MethodDescription
createIndividualClient(requestBody, upsert?)Create or upsert an individual client.
updateIndividualClient(clientId, requestBody)Update an individual client.
getIndividualClient(clientId, integrationId?)Get an individual client by ID.
createCorporateClient(requestBody, upsert?)Create or upsert a corporate client.
updateCorporateClient(clientId, requestBody)Update a corporate client.
getCorporateClient(clientId, includeMembers?, integrationId?)Get a corporate client by ID.

Members

Access via client.members
MethodDescription
createIndividualMember(requestBody, upsert?)Create an individual member (UBO/Director/Signatory).
updateIndividualMember(memberId, requestBody)Update an individual member.
getIndividualMember(memberId)Get an individual member by ID.
addIndividualMemberDocument(memberId, requestBody)Add a document to a member.
getIndividualMemberDocuments(memberId)List member documents.
updateIndividualMemberDocument(memberId, documentId, requestBody)Update a member document.
deleteIndividualMemberDocument(memberId, documentId)Delete a member document.
createCorporateMember(requestBody, upsert?)Create a corporate member.
updateCorporateMember(memberId, requestBody)Update a corporate member.
getCorporateMember(memberId)Get a corporate member by ID.

Deposits

Access via client.deposits
MethodDescription
createDeposit(requestBody, upsert?)Create or upsert a deposit operation.
getDeposit(id)Get a deposit by ID or referenceId.

Withdrawals

Access via client.withdrawals
MethodDescription
createWithdrawal(requestBody, upsert?)Create or upsert a withdrawal operation.
getWithdrawal(id)Get a withdrawal by ID or referenceId.

Transfers

Access via client.transfers
MethodDescription
createTransfer(requestBody, upsert?)Create or upsert a peer-to-peer transfer operation. Both from.client and to.client are required on the transaction.
getTransfer(id)Get a transfer by ID or referenceId.

Trades

Access via client.trades
MethodDescription
createTrade(requestBody, shouldAppendToExistingTrade?, upsert?)Create a trade or append fills to an existing trade.
updateTradeStatus(id, requestBody)Update a trade’s status.
getTrade(id)Get a trade by ID or referenceId.
addTransaction(id, requestBody)Add a transaction to an existing trade.

Transactions

Access via client.transactions
MethodDescription
getTransactionById(id, integrationId?)Get a transaction by ID or referenceId.
updateTransaction(id, requestBody)Update a transaction.
updateTransactionStatus(id, requestBody)Update a transaction’s status.

Alerts

Access via client.alerts
MethodDescription
createAlert(requestBody, failOnAssociation?)Create an alert.
createAlertsBatch(requestBody, failOnAssociation?)Batch create alerts (max 50).
getAlert(alertId)Get an alert by ID.
updateAlert(alertId, requestBody)Update an alert.
bulkUpdateAlertStatus(requestBody)Bulk update alert statuses (max 100).
bulkAssignAlert(requestBody)Bulk assign alerts (max 100).
bulkEscalateAlert(requestBody)Bulk escalate alerts (max 100).
associateAlertWithTransactions(alertId, requestBody)Associate an alert with transactions.
associateAlertWithClients(alertId, requestBody)Associate an alert with clients.
addScreeningMatches(alertId, requestBody)Attach 1–100 screening matches to an existing screening alert.
updateScreeningMatch(alertId, matchId, requestBody)Update a pending screening match before a decision is recorded.
deleteScreeningMatch(alertId, matchId)Delete a pending screening match (recomputes client screening status).

Cases

Access via client.cases
MethodDescription
createCase(requestBody)Create a case.
getCase(caseId)Get a case by ID.
updateCase(caseId, requestBody)Update a case.
bulkUpdateCaseStatus(requestBody)Bulk update case statuses (max 100).
bulkAssignCase(requestBody)Bulk assign cases (max 100).
bulkUpdateCaseReviewers(requestBody)Bulk update case reviewers (max 100).
associateCaseWithTransactions(caseId, requestBody)Associate a case with transactions.
associateCaseWithClients(caseId, requestBody)Associate a case with clients.
associateCaseWithAlerts(caseId, requestBody)Associate a case with alerts.

Bank Accounts

Access via client.bankAccounts
MethodDescription
createBankAccount(requestBody, upsert?)Create or upsert a bank account.
getBankAccount(bankAccountId)Get a bank account by ID or referenceId.
updateBankAccount(bankAccountId, requestBody)Update a bank account.
associateBankAccountWithClients(bankAccountId, requestBody)Associate with clients.

Blockchain Wallets

Access via client.blockchainWallets
MethodDescription
createBlockchainWallet(requestBody, upsert?)Create or upsert a blockchain wallet.
getBlockchainWallet(blockchainWalletId)Get by ID, referenceId, or address.
updateBlockchainWallet(blockchainWalletId, requestBody)Update a wallet.
associateBlockchainWalletWithClients(blockchainWalletId, requestBody)Associate with clients.

Sessions

Access via client.sessions
MethodDescription
createSession(requestBody)Create a session.
getSession(id)Get by ID or referenceId.
updateSession(id, requestBody)Update a session.
getClientSessions(clientId)List sessions for a client.

Rules

Access via client.rules
MethodDescription
createRule(requestBody)Create a rule (draft).
listRules(page?, limit?, ...)List rules with filtering and pagination.
getRule(id, version?)Get a rule by ID.
updateRule(id, requestBody)Update a rule.
activateRule(id, requestBody?)Activate a rule.
disableRule(id, requestBody?)Disable a rule.
deleteRule(id, reason?)Soft delete a rule.

Rule Templates

Access via client.ruleTemplates
MethodDescription
listRuleTemplates(page?, limit?, ...)List rule templates with filtering.
getRuleTemplate(id)Get a rule template by ID.
copyRuleTemplate(id)Copy a template to your workspace as a draft rule.

Evaluation

Access via client.evaluation
MethodDescription
evaluate(requestBody)Evaluate rules against a transaction.
getTransactionEvaluations(transactionId, page?, pageSize?)Get evaluations for a transaction.
getRuleEvaluations(ruleId, page?, pageSize?)Get evaluations for a rule.

Checklists

Access via client.checklists
MethodDescription
getEntityChecklist(entityId)Get the newest active checklist for an entity.
updateChecklistItem(checklistId, itemId, requestBody)Update a checklist item.
createChecklistTemplate(requestBody)Create a checklist template.
getChecklistTemplatesByPlatform(platformId, entityType?)List checklist templates.
getChecklistTemplateById(id)Get a template by ID.
updateChecklistTemplate(id, requestBody)Update a template.
deleteChecklistTemplate(id)Delete a template.
addItemToTemplate(id, requestBody)Add an item to a template.
updateTemplateItem(itemId, requestBody)Update a template item.
deleteTemplateItem(itemId)Delete a template item.

Attachments

Access via client.attachments
MethodDescription
getAttachmentsByEntity(entityType, entityId)Get attachments for an entity.
uploadAttachments(entityType, entityId, formData)Upload files.
getDownloadUrlsByIds(ids)Get download URLs.
updateAttachment(attachmentId, requestBody)Update attachment metadata.
deleteAttachment(attachmentId)Delete an attachment.
relateAttachments(requestBody)Relate attachments to an entity.
createExternalDocument(requestBody)Create an external document attachment.

Payment Accounts

Access via client.paymentAccounts
MethodDescription
createPaymentAccount(requestBody, upsert?)Create or upsert a payment account (PIX, mobile money, CLABE, etc.).
getPaymentAccount(paymentAccountId)Get a payment account by ID or referenceId.
updatePaymentAccount(paymentAccountId, requestBody)Update a payment account.
associatePaymentAccountWithClients(paymentAccountId, requestBody)Associate with clients.

Sub-Dispositions

Access via client.subDispositions
MethodDescription
listSubDispositions()List all sub-dispositions (preset and custom) for the platform.
createSubDisposition(requestBody)Create a custom sub-disposition.
getSubDisposition(id)Get a sub-disposition by ID.
updateSubDisposition(id, requestBody)Update a sub-disposition’s display name or active state.
deleteSubDisposition(id)Soft-delete a custom sub-disposition.

External Rules

Access via client.externalRules
MethodDescription
createExternalRule(requestBody)Register a vendor rule (e.g. Chainalysis, TRM Labs) in Corsa.
listExternalRules(params?)List external rules with pagination.
getExternalRule(id)Get an external rule by ID.
updateExternalRule(id, requestBody)Update an external rule.
deleteExternalRule(id)Soft-delete an external rule.
getExternalRuleVendors()Get distinct vendor names from registered external rules.

Platform

Access via client.platform
MethodDescription
getEncryptionConfiguration()Get the platform’s encryption configuration.

Refer to the type definitions exported from @corsa-labs/sdk for detailed request and response structures.