Changelog
Back to All
Added

API v1.3.0 changelog

about 4 hours ago by Ramon Gonzalez

API v1.3.0 adds endpoints for managing your platform: API keys, delegated users, and employees with two-factor authentication. It also adds endpoints for listing transactions, tracking compliance information requests, and completing more of the KYC flow through the API.

Accounts

  • GET /v1/accounts/paginate: List accounts with cursor-based pagination (next, order, limit). Use this instead of GET /v1/accounts when you manage many accounts.
  • POST /v1/accounts/{accountId}: Update an account's feature-flag preferences with a featureFlags map. The only public flags are named and erebor, and each accepts require, prefer, discourage or forbid.

API keys

  • GET /v1/api_keys: List your API keys, with each key's name, expiry and CIDR allowlist.
  • POST /v1/api_keys: Issue a new API key. expiresAt is required and must be in the future and no more than 1 year away. name and cidrAllowlist are optional.
  • POST /v1/api_keys/{key}: Update an API key's cidrAllowlist, which sets the IP ranges allowed to use the key.
  • DELETE /v1/api_keys/{key}: Revoke an API key so it can no longer authenticate.

When these endpoints are called from an employee session, issuing, updating and revoking keys also requires a Due-Totp-Code header.

Delegated users

  • GET /v1/delegated_users: List your platform's delegated users. You can filter by externalId, and results are paginated.
  • POST /v1/delegated_users: Create a delegated user linked to your own identifier (externalId, required).
  • GET /v1/delegated_users/{id}: Retrieve a delegated user by ID.

Employees

  • GET /v1/employees: List your platform's employees, with each one's name, email, 2FA status and last login.
  • POST /v1/employees: Invite an employee by name and email.
  • GET /v1/employees/{id}: Retrieve an employee by ID.
  • POST /v1/employees/totp: Start two-factor (TOTP) setup for the signed-in employee. The response includes a secret and a uri to add to an authenticator app.
  • POST /v1/employees/totp/confirm: Finish TOTP setup by submitting a one-time code from the authenticator app.

Transfers

  • GET /v1/transactions: List account transactions. You can filter by virtualAccountId or wallet address, and results are paginated.
  • DELETE /v1/virtual_accounts/{id} / DELETE /v1/virtual_accounts/{key}: Deactivate a virtual account, identified by its ID or key, so it stops accepting pay-ins.

Information requests

  • GET /v1/information_requests: List compliance information requests. Each request has a kind (due_diligence or endorsement) and a status (requested, on_review, approved, rejected or expired). You can filter by kind, startDate and endDate, and results are paginated.
  • GET /v1/information_requests/{id}: Retrieve an information request, including its linked KYC submission.
  • GET /v1/transfers/{id}/information_requests: List the information requests raised against a transfer.

KYC

  • POST /v1/kyc/submissions/{submissionId}/agreements: Accept an agreement for a KYC submission by documentSetId, optionally recording the user's ipAddress.
  • GET /v1/kyc/submissions/{submissionId}/beneficiaries: List a submission's beneficial owners, with each one's type, country, roles and share size.
  • POST /v1/kyc/update_profile: Update the applicant's KYC profile details.