API Resources

Common uses

PrimeCore offers a complete set of APIs that enable you to integrate fintech solutions. โ€‹

Authentication

Access API gateway and resources using authentication endpoints.

Resource: /auth/

Use caseEndpoint
Retrieve currentGET/auth/current
Create JWTPOST/auth/jwts
Invalidate sessionsPOST/auth/jwts/invalidate-session
Reset passwordPOST/auth/password_reset
Update passwordPATCH/auth/password_reset/{hash}

Authorization

Access API resources with user objects and JSON Web Tokens (JWTs) credentials.

Users

Create and manage users, required for API authentication and authorization.

Resource: /v2/users

Use caseEndpoint
List usersGET/v2/users
Create usersPOST/v2/users
Retrieve a userGET/v2/users/{user-id}
Update a userPATCH/v2/users/{user-id}
Retrieve current userGET/v2/users/current
Update current userPATCH/v2/users/current
Invalidate JWTPOST/v2/users/current/jwts/invalidate
Validate current user passwordPOST/v2/users/current/password
Activate Time-Based One-Time Password (TOTP)POST/v2/users/current/totp/activate
Submit Time-Based One-Time Password (TOTP) secretPOST/v2/users/current/totp/secret
Invalidate JWTPOST/v2/users/{user-id}/jwts/invalidate
Submit passwordPOST/v2/users/{user-id}/password
Active a user's Time-Based One-Time Password (TOTP)POST/v2/users/{user-id}/totp/activate
Create user's (Time-Based One-Time Password) secretPOST/v2/users/{user-id}/totp/secret

User Invitations

Create and manage user email invites.

Resource: /v2/user-invitations

Use caseEndpoint
List user invitationsGET/v2/user-invitations
Create user invitationsPOST/v2/user-invitations
Retrieve a user invitationPOST/v2/user-invitations
Cancel a user invitationDELETE/v2/user-invitations/{user-invitation-id}
Retrieve a user invitation (sandbox)GET/v2/user-invitations/{user-invitation-id}/sandbox

Accounts

Create and manage custodial and other types of accounts. Accounts require individuals or entities to successfully pass Know Your Customer (KYC) validations.

Resource: /v2/accounts

Use caseEndpoint
List all accountsGET/v2/accounts
Create an accountPOST/v2/accounts
Update an accountPATCH/v2/accounts/{account-id}
Retrieve an accountGET/v2/accounts/{account-id}
List cash transfers for an accountGET/v2/accounts/{account-id}/account-cash-transfers
List authorized transfer accounts for an accountGET/v2/accounts/{account-id}/authorized-transfer-accounts
List internal asset transfers for an accountGET/v2/accounts/{account-id}/internal-asset-transfer
Retrieve a policy for an accountGET/v2/accounts/{account-id}/policy
Update an account (sandbox)PATCH/v2/accounts/{account-id}/sandbox
Freeze an account (sandbox)POST/v2/accounts/{account-id}/sandbox/freeze
Fund an account (sandbox)POST/v2/accounts/{account-id}/sandbox/fund
Open an account (sandbox)POST/v2/accounts/{account-id}/sandbox/open
Unfreeze an account (sandbox)POST/v2/accounts/{account-id}/sandbox/unfreeze

Agreement previews are used to show the contents of a future account agreement to a potential account owner.

Resource: /v2/agreement-previews

Use caseEndpoint
Create agreement previewPOST/v2/agreement-previews

Contacts represent the KYC information and KYC status of the end-user associated with a Prime Trust account. Contacts can also be linked to other objects such as funds-transfers, asset-transfers, funds-transfer-methods, and asset-transfer-methods.

Resource: /v2/contacts

Use caseEndpoint
List contactsGET/v2/contacts
Create a contactPOST/v2/contacts
Retrieve a contactGET/v2/contacts/{contact-id}
Update a contactPATCH/v2/contacts/{contact-id}
Remove a contactDELETE/v2/contacts/{contact-id}
Update a contact (sandbox)PATCH/v2/contacts/{contact-id}/sandbox
Retrieve "related from" contactsGET/v2/contacts/{contact-id}/related-from-contacts
Retrieve "related to" contactGET/v2/contacts/{contact-id}/related-to-contacts

Know Your Customer (KYC)

Handle Customer Identification Program (CIP) checks, Anti-Money Laundering (AML) checks, and Know Your Customer (KYC) checks, along with an endpoint used for uploading supporting documents to Prime Trust. KYC validations are required for opening PrimeCore accounts.

Resource: /v2/cip-checks

Use caseEndpoint
List CIP checksGET/v2/cip-checks
Retrieve CIP checkGET/v2/cip-checks/{cip-check-id}
Submit CIP check for reviewPOST/v2/cip-checks/{cip-check-id}/submit-for-review
Sandbox approvePOST/v2/cip-checks/{cip-check-id}/sandbox/approve
Sandbox denyPOST/v2/cip-checks/{cip-check-id}/sandbox/deny

Resource: /v2/aml-checks

Use caseEndpoint
List AML checksGET/v2/aml-checks
Retrieve AML checkGET/v2/aml-checks/{aml-check-id}
Approve AML check (sandbox)POST/v2/aml-checks/{aml-check-id}/sandbox/approve
Deny AML check (sandbox)POST/v2/aml-checks/{aml-check-id}/sandbox/deny

Resource: /v2/uploaded-documents

Use caseEndpoint
List documentsGET/v2/uploaded-documents
Upload documentsPOST/v2/uploaded-documents
Retrieve a documentGET/v2/uploaded-documents/{uploaded-document-id}
Update an uploaded documentPATCH/v2/uploaded-documents/{uploaded-document-id}

Resource: /v2/kyc-document-checks

Use caseEndpoint
List kyc document checksGET/v2/kyc-document-checks
Create kyc document checkPOST/v2/kyc-document-checks
Retrieve a kyc document checkGET/v2/kyc-document-checks/{kyc-document-check-id}
Retrieve pending kyc document checkGET/v2/kyc-document-checks/pending-by-priority
Fail a kyc document check (sandbox)POST/v2/kyc-document-checks/{kyc-document-check-id}/sandbox/fail
Verify a kyc document check (sandbox)POST/v2/kyc-document-checks/{kyc-document-check-id}/sandbox/verify

โ€‹

Fiat

Manage fiat in / out for accounts.

Fiat In

Contributions represent expected incoming cash deposits. Funds transfers track the lifecycle of cash deposits (contributions) and withdrawals (disbursements) from a Prime Trust account. Contingent holds are temporary holds placed on incoming or outgoing funds or asset transfers that relate to specific checks or actions needing to complete before the funds or assets can be released/free to use.

Resource: /v2/contributions

Use caseEndpoint
List contributionsGET/v2/contributions
Create a contributionPOST/v2/contributions
Retrieve a contributionGET/v2/contributions/{contribution-id}
Cancel a contributionDELETE/v2/contributions/{contribution-id}
Authorize (sandbox)POST/v2/contributions/{contribution-id}/sandbox/authorize
Settle (sandbox)POST/v2/contributions/{contribution-id}/sandbox/settle
Cancel (sandbox)POST/v2/contributions/{contribution-id}/cancel
Timeout (sandbox)POST/v2/contributions/sandbox/timeout

Resource: /v2/funds-transfers

Use caseEndpoint
List funds transfersGET/v2/funds-transfers
Retrieve a funds transferGET/v2/funds-transfers/{funds-transfer-id}
Cancel a funds transferPOST/v2/funds-transfers/{funds-transfer-id}/cancel
Clear a funds transfer (sandbox)POST/v2/funds-transfers/{funds-transfer-id}/sandbox/clear
Settle a funds transfer (sandbox)POST/v2/funds-transfers/{funds-transfer-id}/sandbox/settle
Reverse a funds transfer (sandbox)POST/v2/funds-transfers/{funds-transfer-id}/sandbox/reverse

Resource: /v2/contingent-holds

Use caseEndpoint
List contingent holdsGET/v2/contingent-holds
Retrieve a contingent holdGET/v2/contingent-holds/{contingent-hold-id}
Update a contingent holdPATCH/v2/contingent-holds/{contingent-hold-id}
Clear a contingent holdPOST/v2/contingent-holds/{contingent-hold-id}/clear
Update a contingent hold (sandbox)PATCH/v2/contingent-holds/{contingent-hold-id}/sandbox
Clear a contingent hold (sandbox)POST/v2/contingent-holds/{contingent-hold-id}/sandbox/clear

Internal fiat

Account cash transfers allow the transfer of cash from one Prime Trust account to another Prime Trust account.

Resource: /v2/account-cash-transfers

Use caseEndpoint
List cash transfersGET/v2/account-cash-transfers
Create a cash transferPOST/v2/account-cash-transfers
Retrieve a cash transferGET/v2/account-cash-transfers/{account-cash-transfer-id}
Cancel a cash transferDELETE/v2/account-cash-transfers/{account-cash-transfer-id}
Approve a cash transfer (sandbox)POST/v2/account-cash-transfers/{account-cash-transfer-id}/sandbox/approve
Deny a cash transfer (sandbox)POST/v2/account-cash-transfers/{account-cash-transfer-id}/sandbox/deny
Timeout a cash transfer (sandbox)POST/v2/account-cash-transfers/sandbox/timeout

Trades can be used to represent instant swaps / settlement of assets and cash.

Resource: /v2/trades

Use caseEndpoint
List tradesGET/v2/trades
Create a tradePOST/v2/trades
Retrieve a tradeGET/v2/trades/{trade-id}
Settle a tradePOST/v2/trades/{trade-id}/settle
Cancel a tradePOST/v2/trades/{trade-id}/cancel

Fiat Out

Disbursements are requests to withdraw cash out of an account at Prime Trust to an external location.

Resource: /v2/disbursements

Use caseEndpoint
List disbursementsGET/v2/disbursements
Create a disbursementPOST/v2/disbursements
Retrieve a disbursementGET/v2/disbursements/{disbursement-id}
Cancel a disbursementDELETE/v2/disbursements/{disbursement-id}
Authorize a disbursement (sandbox)POST/v2/disbursements/{disbursement-id}/sandbox/authorize

Funds transfers track the lifecycle of cash deposits (contributions) and withdrawals (disbursements) from a Prime Trust account.

Resource: /v2/funds-transfers

Use caseEndpoint
List funds transfersGET/v2/funds-transfers
Retrieve a funds transferGET/v2/funds-transfers/{funds-transfer-id}
Cancel a funds transferPOST/v2/funds-transfers/{funds-transfer-id}/cancel
Clear a funds transfer (sandbox)POST/v2/funds-transfers/{funds-transfer-id}/sandbox/clear
Settle a funds transfer (sandbox)POST/v2/funds-transfers/{funds-transfer-id}/sandbox/settle
Reverse a funds transfer (sandbox)POST/v2/funds-transfers/{funds-transfer-id}/sandbox/reverse

Disbursement authorizations track the verification and authorization lifecycle of an outgoing asset or funds transfer.

Resource: v2/disbursement-authorizations

Use caseEndpoint
List disbursement authorizationsGET/v2/disbursement-authorizations
Retrieve a disbursement authorizationGET/v2/disbursement-authorizations/{disbursement-authorization-id}
Retry owner verificationPOST/v2/disbursement-authorizations/{disbursement-authorization-id}/retry-owner-verification
Authorize disbursement authorization (sandbox)GET/v2/disbursement-authorizations/{disbursement-authorization-id}/sandbox/authorize
Verify owner (sandbox)POST/v2/disbursement-authorizations/{disbursement-authorization-id}/sandbox/verify-owner
Retrieve owner verificationGET/v2/disbursement-owner-verifications/{resource-token-hash}
Create owner verificationPOST/v2/disbursement-owner-verifications/{resource-token-hash}

Contingent holds are temporary holds placed on incoming or outgoing funds or asset transfers that relate to specific checks or actions needing to complete before the funds or assets can be released/free to use.

Resource: /v2/contingent-holds

Use caseEndpoint
List contingent holdsGET/v2/contingent-holds
Retrieve a contingent holdGET/v2/contingent-holds/{contingent-hold-id}
Update a contingent holdPATCH/v2/contingent-holds/{contingent-hold-id}
Clear a contingent holdPOST/v2/contingent-holds/{contingent-hold-id}/clear
Update a contingent hold (sandbox)PATCH/v2/contingent-holds/{contingent-hold-id}/sandbox
Clear a contingent hold (sandbox)POST/v2/contingent-holds/{contingent-hold-id}/sandbox/clear

Total Fiat - Account

Account cash totals provides the cash balances for an account.

Resource: /v2/account-cash-totals

Use caseEndpoint
List cash totalsGET/v2/account-cash-totals
Get a totalGET/v2/account-cash-totals/{account-cash-total-id}

Prime X

Authorization

Account transfer authorizations allow for the transfer of cash or assets between Prime Trust accounts controlled by different users.

Resource: /v2/account-transfer-authorizations

Use caseEndpoint
List account transfer authorizationsGET/v2/account-transfer-authorizations
Create account transfer authorizationPOST/v2/account-transfer-authorizations
Retrieve an account transfer authorizationGET/v2/account-transfer-authorizations/{account-transfer-authorization-id}
Update an account transfer authorizationPATCH/v2/account-transfer-authorizations/{account-transfer-authorization-id}

Resource: /v2/accounts/

Use caseEndpoint
Retrieve authorized transfer accountsGET/v2/accounts/{account-id}/authorized-transfer-accounts

โ€‹

Assets

Assets are representations of all the underlying assets Prime Trust can custody.

Assets in

Resource: /v2/assets

Use caseEndpoint
List assetsGET/v2/assets
Retrieve an assetGET/v2/assets/{asset-id}

Asset transfer methods provide instructions on where assets will be received or where Prime Trust should send outgoing assets.

Resource: /v2/asset-transfer-methods

Use caseEndpoint
List asset transfer methodsGET/v2/asset-transfer-methods
Create an asset transfer methodPOST/v2/asset-transfer-methods
Retrieve an asset transfer methodGET/v2/asset-transfer-methods/{asset-transfer-method-id}
Update an asset transfer methodPATCH/v2/asset-transfer-methods/{asset-transfer-method-id}

Asset contributions represent expected incoming asset deposits (digital or traditional assets deposits).

Resource: /v2/asset-contributions

Use caseEndpoint
List asset contributionsGET/v2/asset-contributions
Create an asset contribtutionPOST/v2/asset-contributions
Retrieve an asset contributionGET/v2/asset-contributions/{asset-contribution-id}

Asset transfers represent the lifecycle of incoming or outgoing assets from an account external of the Prime Trust ecosystem.

Resource: v2/asset-transfers

Use caseEndpoint
List asset transfersGET/v2/asset-transfers
Retrieve an asset transferGET/v2/asset-transfers/{asset-transfer-id}
Clear an asset transfer (sandbox)POST/v2/asset-transfers/{asset-transfer-id}/sandbox/clear
Settle an asset transfer (sandbox)POST/v2/asset-transfers/{asset-transfer-id}/sandbox/settle

Internal asset movement

Internal assets transfers allow the transfer of assets from one Prime Trust account to another Prime Trust account.

Resource: /v2/internal-asset-transfers

Use caseEndpoint
List internal asset transfersGET/v2/internal-asset-transfers
Create an internal asset transferPOST/v2/internal-asset-transfers
Retrieve an internal asset transferGET/v2/internal-asset-transfers/{internal-asset-transfer-id}
Approve an internal asset transfer (sandbox)POST/v2/internal-asset-transfers/{internal-asset-transfer-id}/sandbox/approve
Deny an internal asset transfer (sandbox)POST/v2/internal-asset-transfers/{internal-asset-transfer-id}/sandbox/deny

Resource: /v2/sub-asset-transfers

Use caseEndpoint
List sub asset transfersGET/v2/sub-asset-transfers
Create a sub asset transferPOST/v2/sub-asset-transfers
Retrieve a sub asset transferGET/v2/sub-asset-transfers/{sub-asset-transfer-id}
Cancel a sub asset transferPOST/v2/sub-asset-transfers/{sub-asset-transfer-id}/cancel
Settle a sub asset transfer (sandbox)POST/v2/sub-asset-transfers/{sub-asset-transfer-id}/sandbox/settle

Trades are generated after a successful quote execution, and can also be used to represent instant swaps / settlement of assets and cash.

Resource: /v2/trades

Use caseEndpoint
List tradesGET/v2/trades
Create a tradePOST/v2/trades
Retrieve a tradeGET/v2/trades/{trade-id}
Settle a tradePOST/v2/trades/{trade-id}/settle
Cancel a tradePOST/v2/trades/{trade-id}/cancel

Asset purchasing / selling

Quotes request a quote from an OTC desk(s) in order to buy and sell BTC and ETH for USD. You are restricted by the amount of funds or assets held in your account.

Resource: /v2/quotes

Use caseEndpoint
Request a quotePOST/v2/quotes
List quotesGET/v2/quotes
Retrieve a quoteGET/v2/quotes/{quote-id}
Execute a quotePOST/v2/quotes/{quote-id}/execute

Assets Out

Asset disbursements represent a request to send assets out of an account to a specified external location.

Resource: /v2/asset-disbursements

Use caseEndpoint
List asset disbursementsGET/v2/asset-disbursements
Create an asset disbursementPOST/v2/asset-disbursements
Retrieve an asset disbursementGET/v2/asset-disbursements/{asset-disbursement-id}

Asset transfers represent the lifecycle of incoming or outgoing assets from an account external of the Prime Trust ecosystem.

Resource: /v2/asset-transfers

Use caseEndpoint
List asset transfersGET/v2/asset-transfers
Retrieve an asset transferGET/v2/asset-transfers/{asset-transfer-id}
Clear an asset transfer (sandbox)POST/v2/asset-transfers/{asset-transfer-id}/sandbox/clear
Settle an asset transfer (sandbox)POST/v2/asset-transfers/{asset-transfer-id}/sandbox/settle

Disbursement authorizations track the verification and authorization lifecycle of an outgoing asset or funds transfer.

Resource: /v2/disbursement-authorizations

Use caseEndpoint
List disbursement authorizationsGET/v2/disbursement-authorizations
Retrieve a disbursement authorizationGET/v2/disbursement-authorizations/{disbursement-authorization-id}
Retry owner verificationPOST/v2/disbursement-authorizations/{disbursement-authorization-id}/retry-owner-verification
Authorize disbursement authorization (sandbox)GET/v2/disbursement-authorizations/{disbursement-authorization-id}/sandbox/authorize
Verify owner (sandbox)POST/v2/disbursement-authorizations/{disbursement-authorization-id}/sandbox/verify-owner
Retrieve owner verificationGET/v2/disbursement-owner-verifications/{resource-token-hash}
Create owner verificationPOST/v2/disbursement-owner-verifications/{resource-token-hash}

โ€‹

Trades

Trades are generated after a successful quote execution, and can also be used to represent instant swaps / settlement of assets and cash.

Resource: /v2/trades

Use caseEndpoint
List tradesGET/v2/trades
Create a tradePOST/v2/trades
Retrieve a tradeGET/v2/trades/{trade-id}
Settle a tradePOST/v2/trades/{trade-id}/settle
Cancel a tradePOST/v2/trades/{trade-id}/cancel

โ€‹

Webhooks

Webhook configs are set on a per account level and control settings related to webhooks including which URL the webhooks related to that account will be sent to.

Webhooks present a log of webhooks over the past 60 days that Prime Trust has or would have fired along with failure details if the webhooks fired.

Resource: /v2/webhook-config

Use caseEndpoint
List webhook configGET/v2/webhook-configs
Create a webhook configPOST/v2/webhook-configs
Retrieve a webhook configGET/v2/webhook-configs/{webhook-config-id}
Update a webhook configPATCH/v2/webhook-configs/{webhook-config-id}
Test a webhook configPOST/v2/webhook-configs/{webhook-config-id}/test

Resource: /v2/webhooks

Use caseEndpoint
List webhooksGET/v2/webhooks
Retrieve a webhookGET/v2/webhooks/{webhook-id}
Retry a webhookPOST/v2/webhooks/{webhook-id}/retry

Sandbox

List of routes that allow developers to take actions in the sandbox environment that in the production environment would require a Prime Trust officer to take.

  • POST/v2/account-cash-transfers/{account-cash-transfer-id}/sandbox/approve

  • POST/v2/account-cash-transfers/{account-cash-transfer-id}/sandbox/deny

  • POST/v2/account-cash-transfers/sandbox/timeout

  • POST/v2/account-policies/sandbox

  • PATCH/v2/account-policies/{account-policy-id}/sandbox/update

  • DELETE/v2/account-policies/{account-policy-id}/sandbox/destroy

  • PATCH/v2/accounts/{account-id}/sandbox

  • POST/v2/accounts/{account-id}/sandbox/freeze

  • POST/v2/accounts/{account-id}/sandbox/fund

  • POST/v2/accounts/{account-id}/sandbox/open

  • POST/v2/accounts/{account-id}/sandbox/unfreeze

  • POST/v2/aml-checks/{aml-check-id}/sandbox/approve

  • POST/v2/aml-checks/{aml-check-id}/sandbox/deny

  • POST/v2/asset-transfers/{asset-transfer-id}/sandbox/clear

  • POST/v2/asset-transfers/{asset-transfer-id}/sandbox/settle

  • GET/v2/card-holder-verifications/{hash}/sandbox

  • GET/v2/card-holders/{card-holder-id}/sandbox

  • POST/v2/card-transactions/sandbox

  • PATCH/v2/card-transactions/{card-transactions-id}/sandbox

  • POST/v2/chargebacks/{chargeback-id}/sandbox/win

  • POST/v2/chargebacks/sandbox

  • POST/v2/cip-checks/{cip-check-id}/sandbox/approve

  • POST/v2/cip-checks/{cip-check-id}/sandbox/deny

  • POST/v2/contact-funds-transfer-references/{contact-funds-transfer-reference-id}/sandbox/contribution

  • PATCH/v2/contacts/{contact-id}/sandbox

  • PATCH/v2/contingent-holds/{contingent-hold-id}/sandbox

  • POST/v2/contingent-holds/{contingent-hold-id}/sandbox/clear

  • POST/v2/contributions/{contribution-id}/sandbox/authorize

  • POST/v2/contributions/{contribution-id}/sandbox/settle

  • POST/v2/contributions/sandbox/timeout

  • GET/v2/credit-card-resources/{credit-card-resource-id}/sandbox

  • POST/v2/credit-card-resources/{credit-card-resource-id}/sandbox/verify

  • GET/v2/disbursement-authorizations/{disbursement-authorization-id}/sandbox/authorize

  • POST/v2/disbursement-authorizations/{disbursement-authorization-id}/sandbox/verify-owner

  • POST/v2/disbursements/{disbursement-id}/sandbox/authorize

  • POST/v2/funds-transfers/{funds-transfer-id}/sandbox/clear

  • POST/v2/funds-transfers/{funds-transfer-id}/sandbox/settle

  • POST/v2/funds-transfers/{funds-transfer-id}/sandbox/reverse

  • POST/v2/internal-asset-transfers/{internal-asset-transfer-id}/sandbox/approve

  • POST/v2/internal-asset-transfers/{internal-asset-transfer-id}/sandbox/deny

  • POST/v2/kyc-document-checks/{kyc-document-check-id}/sandbox/fail

  • POST/v2/kyc-document-checks/{kyc-document-check-id}/sandbox/verify

  • POST/v2/plaid-items/{plaid-item-id}/sandbox/reset

  • POST/v2/sub-asset-transfers/{sub-asset-transfer-id}/sandbox/settle

  • GET/v2/user-invitations/{user-invitation-id}/sandbox

Last updated on