Email Address of the user

The auth token received can only be used to access the following endpoints:

• /identities
• /access_token

• SMS: The one-time-password is sent as a text message

A randomly generated one-time use code.

• AUTHY: The push notification is sent on the user's device using Twilio Authy
• BIOMETRIC: The push notification is sent to the user's device

• OTP: The OTP is sent as a text message
• PUSH: The authorisation request is sent as a push notification
• BIOMETRIC: The push notification is sent via Firebase to a mobile application

The state of the factor type.

• PENDING_VERIFICATION : The user has started the enrolment process but still hasn't completed enrolment. Challenges cannot be used before they are verified.
• ACTIVE : The user has successfully completed enrolment and the challenge can be used to verify transactions.
• INACTIVE : The user has rejected the enrolment.

• SMS: The one-time-password is sent as a text message
• AUTHY: The push notification is sent to an Authy application
• BIOMETRIC: The push notification is sent to an innovator application

• AUTHY: The push notification is sent on the user's device using Twilio Authy

The operation type upon which an SCA Challenge is being contested.

The tag field is a custom field that can be used to search and filter.

BCP47 locale code (e.g. en, en-US). The locale determines which email and SMS user notification templates are used.

Brand identifier used to determine the set of email and SMS user notification templates. Must be alphanumeric, up to 25 characters, and contain no spaces.

The current status of the bulk process:

• SUBMITTED: The bulk process data has been persisted and is ready for execution. This is the initial state.
• RUNNING: The bulk process is currently being executed.
• PARTIALLY_COMPLETED: Execution is complete, but some bulk operations failed. This is a final state.
• COMPLETED: Execution is complete, and all bulk operations succeeded. This is a final state.
• FAILED: No operations in the bulk process were executed. This is a final state.
• PAUSED: Execution has been paused and can be resumed.
• CANCELLED: Execution has been cancelled. This is a final state.

ON_FAILURE_STOP : the execution of the bulk process stops after the first bulk operation that fails (operation returns a 4xx or 5xx response code). ON_FAILURE_CONTINUE: the execution of the bulk process resumes as normal even when any of the bulk operations fail.

The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.

The time period for which the spendLimit is valid.

• DAILY: starting from 00:00:00 UTC of current day to 23:59:59 UTC of current day

• WEEKLY: 00:00:00 UTC Monday of current week to following Sunday 23:59:59 UTC

• MONTHLY: 1st of current calendar month to end of current calendar month

• QUARTERLY: starting from beginning of current quarter where quarters are defined as follows:

• 1 January 00:00:00 UTC to 31 March 23:59:59 UTC

• 1 April 00:00:00 UTC to 30 Jun 23:59:59 UTC

• 1 July 00:00:00 UTC to 30 September 23:59:59 UTC

• 1 October 00:00:00 UTC to 31 December 23:59:59 UTC

• YEARLY: 1 January 00:00:00 UTC of current calendar year to 31 December 23:59:59 UTC of current calendar year.

• ALWAYS: This indicates that the spendLimit is the total amount that can be spent through the card throughout the whole lifetime of the card.

The spend limit update method to apply. Currently supported:

• OVERWRITE: (default option if nothing selected). Overwrites the previous values for the spendLimit object i.e. sets new limits
• INCREMENT : This will increase the existing value of the spend limit by the amount input the value field. If used in conjunction with an ALWAYS interval, this can be used to increment a spend limit on a periodic basis (controlled by you, e.g. monthly), and means that any 'unused' balance from the previous period will still available to spend. See examples in our documentation

The epoch timestamp at which the transaction is scheduled to be executed.

The profile Id which a specific identity, instrument or transaction type is linked to.

Profiles contain configuration and determine behavioral aspects of the newly created transaction, for example, fees that may apply.

You can have one or more profiles linked to your application, and these can be used to drive different behaviors according to your product's needs.

Profile Ids can be found in the Multi Portal, in the API Credentials page.

Nationality of the user - using ISO 3166 alpha-2.

The date of birth in ISO 8601 format (YYYY-MM-DD).

A randomly generated one-time use code used to verify the user's email address or mobile number.

The company position of the Corporate Root User.

Supported company types - if company type is not listed, please contact our support team to check if the company type can be supported.

The industry of the identity.

The corporate's source of funds.

Status of the transaction.

The category of fee — indicates the activity or instrument-lifecycle event the fee relates to.

Lifecycle status of a fee transaction:

• PENDING: Fee accompanies a transaction that is still processing; it may still be cancelled.
• COMPLETED: Fee was charged and posted to the instrument balance.
• CANCELLED: Fee was cancelled before being charged.
• REVERSED: Fee was previously charged and has been reversed.

The industry of the identity.

The consumer's source of funds.

The KYC level, which determines what KYC information will be requested from the consumer:

• KYC_LEVEL_1: The most basic level of KYC required.
• KYC_LEVEL_2: Full due diligence level 2

The state of the instrument indicating what it can and cannot do as follows:

• ACTIVE: The instrument is in an active state and can be used in transactions.
• BLOCKED: The instrument is temporarily blocked and cannot be used. Any funds on the instrument are also frozen. The blockedReason provides more information as to why it was blocked.
• DESTROYED: The instrument has been permanently destroyed. The destroyReason provides more information as to why it was destroyed.
• NOT_ENABLED: The instrument is not enabled for use, since the linked user has not completed all necessary verification steps.

An account can be of two types, Personal or Business:

• PERSONAL means that the account held at the external bank or PSP is registered under the ownership of a natural person or consumer identity;
• BUSINESS means that the account held at the external bank or PSP is registered under the ownership of a corporate entity.

The state of the linked account:

• PENDING_VERIFICATION: The Linked Account is pending the completion of the required verification steps.
• ACTIVE: The Linked Account is verified and active, ready to be used for self-to-self wire transfers.
• BLOCKED: The Linked Account is temporarily blocked, preventing any use of this external account in self-to-self wire transfers. A Linked Account can be unblocked by calling the Multi API endpoint POST /linked_accounts/{id}/unblock.
• REMOVED: The Linked Account has been removed from the platform and can no longer be used for self-to-self wire transfers unless a new verification is completed in future.
• REJECTED: The Linked Account failed the verification process and cannot be used for self-to-self wire transfers unless a new verification is completed in future. A Linked Account can transition through these different overall states, starting at the PENDING_VERIFICATION state until all verification steps are followed through.

The id of the Linked Account Profile which this instrument is linked to.

You can have one or more profiles linked to your application, and these can be used to drive different behaviours according to your product's needs.

This field is necessary only if you have been provided with multiple Linked Account Profiles.

Profile Ids can be found in the Multi Portal, in the API Credentials page.

The reason why the instrument has been blocked:

• USER: The root, or an authorised user, of the identity owning the instrument has temporarily blocked the instrument.
• SYSTEM: The platform or an administrator of the platform has temporarily blocked the instrument.
• LOST: The instrument has been blocked because it was marked as lost.
• SINGLE_SPEND: The instrument has been automatically blocked after its first successful transaction (single-spend card).

The reason why the instrument has been destroyed:

• SYSTEM: The platform or an administrator of the platform has destroyed the instrument.
• USER: The root, or an authorised user, of the identity owning the instrument has destroyed the instrument.
• LOST: The instrument was automatically destroyed as it was marked as lost.
• STOLEN: The instrument was automatically destroyed as it was marked as stolen.
• EXPIRED: The instrument was automatically destroyed as it expired.
• COMPROMISED: The instrument was automatically destroyed as it was marked as compromised.
• SINGLE_SPEND: The instrument was automatically destroyed as it was a single-spend card that was used.

Sends a low balance notification webhook when the available balance drops below this amount. Currency is inherited from the managed account.

The transaction entry state, as follows:

• PENDING: The transaction has started and some of the fund movements have completed, however additional fund movements are still pending to finalise the transaction.
• COMPLETED: All fund movements for a transaction have completed.

The top-level type of transaction represented by this statement entry.

The type of access instrument that initiated a transaction.

Subtype of a card payment statement entry.

Subtype of an outgoing wire transfer statement entry.

Subtype of an incoming wire transfer statement entry.

Subtype of a correspondent bank transfer statement entry.

The specific kind of system-generated transaction.

The digital wallet type.

The type of transaction:

• transfers: Internal transfer between instruments of the same identity
• sends: Transfer between instruments of different identities
• outgoing_wire_transfers: Wire transfer to an external bank account
• correspondent_bank_transfers: Wire transfer on behalf of a third-party originator
• incoming_wire_transfers: Wire transfer received from an external bank account
• card_payments: Card payment (purchase, refund, OCT, etc.) with full lifecycle
• fees: Fee charged or reversed on an instrument
• system_transactions: System-generated transactions (balance adjustments, account closures, dispute outcomes, etc.)

Normalised lifecycle status of a transaction:

• DRAFT: Transaction ID has been created. There are additional user-actions required before the transaction is considered an “executable instruction” that is fully submitted. No balance movements have taken place on the target instrument yet.
• SUBMITTED: Transaction has been submitted and is awaiting processing. No balance movements have taken place yet. Transactions scheduled for processing on a future date remain in a submitted status.
• PROCESSING: The submitted transaction is being processed.
• COMPLETED: Executed and processed. Funds have moved, actual balance changed.
• CANCELLED: Transaction was cancelled before completion. Funds have been returned to the original instrument.
• RETURNED: The transaction was previously COMPLETED but has been returned. Funds have been returned to the original instrument. Note that card refunds may be separate transactions, not RETURNED purchases.

Whether funds were credited to or debited from the instrument.

The field to sort transaction activity results by:

• creationTimestamp: Sort by when the transaction was first created (default).
• lastUpdatedTimestamp: Sort by when the transaction was most recently updated.

The epoch timestamp at which the transaction was executed, transitioning to a final state such as COMPLETED, REJECTED, or FAILED.

The reason the scheduled transaction was cancelled.

The state of the send transaction, as follows:

• INVALID: The send transaction has failed initial validation checks.
• INITIALISED: The initial state of a send transaction when SCA is not required.
• PENDING_CHALLENGE: The send transaction requires the completion of a transaction confirmation challenge before it can be submitted.
• PENDING: The send transaction has exceeded the destination limit and is pending treasury approval.
• APPROVED: The send transaction that was submitted has been approved.
• COMPLETED: The requested funds have been sent from the source instrument.
• REJECTED: The send transaction that was submitted was rejected.
• FAILED: There was an issue with the send transaction, and the transaction has failed.
• RETURNED: The send transaction has been returned to the sender.
• SCHEDULED: The send transaction will be executed at the scheduled time.
• CANCELLED: The scheduled send transaction has been cancelled.

The Reason the transaction was exempted from SCA verification