E-mail Address of the user

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

Information on the manufacturing of the physical card, as follows:

• REQUESTED: The upgrade of the card to physical has been requested.
• SENT_FOR_FULFILLMENT - The card has been sent for printing.
• DISPATCHED: The card has been manufactured and dispatched. You may receive a second DISPATCHED event when the manufacturer provides a tracking code.
• DELIVERED: The card has been received and activated by the recipient.

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 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.

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

A randomly generated one-time use code.

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

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.

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

The industry of the identity.

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

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 delivery methods supported for delivering printed physical cards. If not specified, the STANDARD_DELIVERY method will be used.

Bulk delivery is available for deliveryMethods REGISTERED_MAIL or COURIER. All cards marked as bulk and ordered within the fulfilment centre’s dispatch window will be sent in bulk. Delivery address must be identical for all orders. contactNumber in the deliveryAddress object is mandatory when bulk is selected. Maximum number of cards delivered in a single box/packet is REGISTERED_MAIL = 90, COURIER = 200.

Indicates how the card will be handled once it is close to expiring.

• RENEW: The card will be automatically renewed, keeping the same card number but with a new expiry date and CVV.
• NO_RENEW: Once the expiry date is reached, the card is destroyed.

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

• "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

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

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.

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.

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.

Status of the transaction.

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 state of the Outgoing wire transfer transaction, as follows:

• INVALID: The wire transfer has failed initial validation checks.
• PENDING_CHALLENGE: The wire transfer requires the completion of a transaction confirmation challenge before it can be submitted.
• SUBMITTED: The wire transfer has been submitted to the sending financial institution for processing.
• REJECTED: The wire transfer that was submitted was rejected.
• APPROVED: The wire transfer that was submitted has been approved and is being processed by the sending financial institution.
• FAILED: There was an issue with the wire transfer, and the transaction has failed.
• COMPLETED: The requested funds have been sent from the source instrument.
• RETURNED: The wire transfer has been returned to the sender.
• SCHEDULED: The wire transfer will be executed at the scheduled time.
• CANCELLED: The scheduled wire transfer has been cancelled.
• PENDING_CONFIRMATION: The wire transfer requires a manual confirmation by the user before proceeding.

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

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.

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 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 the scheduled transaction was cancelled.

The value that determines whether a Beneficiary is trusted or not.

• "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