{"items":[{"type":"link","label":"Weavr Multi Product API","link":"/products/multi/openapi","routeSlug":"/products/multi/openapi"},{"type":"link","label":"Authentication","link":"/products/multi/openapi/section/authentication","routeSlug":"/products/multi/openapi/section/authentication"},{"type":"separator","label":"Customer Registration"},{"type":"group","label":"Corporates","link":"/products/multi/openapi/corporates","routeSlug":"/products/multi/openapi/corporates","items":[{"label":"Register a corporate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/corporates/corporatecreate","routeSlug":"/products/multi/openapi/corporates/corporatecreate","metadata":{"seo":{"title":"Register a corporate","description":"Create a corporate identity for a business customer. The information provided must be accurate and will be passed on for KYB verification with our partner."}},"httpPath":"/corporates"},{"label":"Submit known KYB entity data for the corporate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/corporates/corporatekybsubmitentity","routeSlug":"/products/multi/openapi/corporates/corporatekybsubmitentity","metadata":{"seo":{"title":"Submit known KYB entity data for the corporate","description":"Submit the company and ownership-graph information you already hold for the corporate, to pre-populate its KYB before the corporate starts their KYB journey. Optional; all fields are optional."}},"httpPath":"/corporates/{corporateId}/kyb/entity"},{"label":"Get the submitted KYB entity data for the corporate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/corporates/corporatekybgetentity","routeSlug":"/products/multi/openapi/corporates/corporatekybgetentity","metadata":{"seo":{"title":"Get the submitted KYB entity data for the corporate","description":"Return the company and ownership-graph information submitted to pre-populate the corporate's KYB."}},"httpPath":"/corporates/{corporateId}/kyb/entity"},{"label":"Submit the KYB account-usage profile for the corporate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/corporates/corporatekybsetprofile","routeSlug":"/products/multi/openapi/corporates/corporatekybsetprofile","metadata":{"seo":{"title":"Submit the KYB account-usage profile for the corporate","description":"Submit the corporate's account-usage profile (funding, collections, withdrawals, payouts, cards) to pre-populate its KYB. Optional."}},"httpPath":"/corporates/{corporateId}/kyb/profile"},{"label":"Get the submitted KYB account-usage profile for the corporate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/corporates/corporatekybgetprofile","routeSlug":"/products/multi/openapi/corporates/corporatekybgetprofile","metadata":{"seo":{"title":"Get the submitted KYB account-usage profile for the corporate","description":"Return the account-usage profile submitted to pre-populate the corporate's KYB."}},"httpPath":"/corporates/{corporateId}/kyb/profile"},{"label":"Upload a KYB supporting document for the corporate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/corporates/corporatekybuploaddocument","routeSlug":"/products/multi/openapi/corporates/corporatekybuploaddocument","metadata":{"seo":{"title":"Upload a KYB supporting document for the corporate","description":"Upload a supporting document to pre-populate the corporate's KYB before the corporate starts their KYB journey. Optional; one document per call (up to 10MB)."}},"httpPath":"/corporates/{corporateId}/kyb/documents"},{"label":"List the uploaded KYB documents for the corporate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/corporates/corporatekybgetdocuments","routeSlug":"/products/multi/openapi/corporates/corporatekybgetdocuments","metadata":{"seo":{"title":"List the uploaded KYB documents for the corporate","description":"List the documents uploaded to pre-populate the corporate's KYB. Returns metadata only, no binaries."}},"httpPath":"/corporates/{corporateId}/kyb/documents"}]},{"type":"group","label":"Consumers","link":"/products/multi/openapi/consumers","routeSlug":"/products/multi/openapi/consumers","items":[{"label":"Register a consumer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/consumers/consumercreate","routeSlug":"/products/multi/openapi/consumers/consumercreate","metadata":{"seo":{"title":"Register a consumer","description":"Create a Consumer Identity to represent an Individual."}},"httpPath":"/consumers"}]},{"type":"separator","label":"Users & User Authentication"},{"type":"group","label":"Setup","link":"/products/multi/openapi/setup","routeSlug":"/products/multi/openapi/setup","items":[{"label":"Register a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/setup/usercreate","routeSlug":"/products/multi/openapi/setup/usercreate","metadata":{"seo":{"title":"Register a user","description":"Creates a user linked to the logged-in corporate or consumer identity."}},"httpPath":"/users"},{"label":"Get all users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/setup/usersget","routeSlug":"/products/multi/openapi/setup/usersget","metadata":{"seo":{"title":"Get all users","description":"Fetches all users associated with the corporate or consumer identity the logged-in user belongs to."}},"httpPath":"/users"},{"label":"Get a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/setup/usergetbyid","routeSlug":"/products/multi/openapi/setup/usergetbyid","metadata":{"seo":{"title":"Get a user","description":"Retrieves the user identified by the user_id path parameter."}},"httpPath":"/users/{user_id}"},{"label":"Update a user","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/setup/userupdate","routeSlug":"/products/multi/openapi/setup/userupdate","metadata":{"seo":{"title":"Update a user","description":"Update the details of a user identified by the user_id in the the path parameter."}},"httpPath":"/users/{user_id}"},{"label":"Get linked identities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/setup/useridentities","routeSlug":"/products/multi/openapi/setup/useridentities","metadata":{"seo":{"title":"Get linked identities","description":"Retrieves a list of identities available to the holder of the token."}},"httpPath":"/identities"},{"label":"Invite a user to set a password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/setup/userinvitesend","routeSlug":"/products/multi/openapi/setup/userinvitesend","metadata":{"seo":{"title":"Invite a user to set a password","description":"Sends an invitation to a user to join your identity. Once a user is created using the userCreate operation, an invitation needs to be sent to the user in order to be able to set up the password for the first time. The invitation email, which remains valid for 1 month, will contain a URL having all information required to setup the password via the userInviteConsume."}},"httpPath":"/users/{user_id}/invite"},{"label":"Validate a user's invite","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/setup/userinvitevalidate","routeSlug":"/products/multi/openapi/setup/userinvitevalidate","metadata":{"seo":{"title":"Validate a user's invite","description":"Check if a user's invite is still valid. This operation is useful to avoid having the user fill in a form only to be held by a validation issue (eg. expired invite)."}},"httpPath":"/users/{user_id}/invite/validate"},{"label":"Consume a user's invite","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/setup/userinviteconsume","routeSlug":"/products/multi/openapi/setup/userinviteconsume","metadata":{"seo":{"title":"Consume a user's invite","description":"Consumes an invitation perviously sent to the user via userInviteSend. This is needed so that the invited user sets up the password."}},"httpPath":"/users/{user_id}/invite/consume"},{"label":"Send an email verification code to a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/setup/authoriseduseremailverificationcodesend","routeSlug":"/products/multi/openapi/setup/authoriseduseremailverificationcodesend","metadata":{"seo":{"title":"Send an email verification code to a user","description":"The first step in verifying an authorised user's email. The authorised user whose email address is to be verified is sent an email containing a randomly generated code."}},"httpPath":"/users/verification/email/send"},{"label":"Verify email of the authorised user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/setup/authoriseduseremailverify","routeSlug":"/products/multi/openapi/setup/authoriseduseremailverify","metadata":{"seo":{"title":"Verify email of the authorised user","description":"The second step in verifying the authorised user's email. The randomly generated code sent to the authorised user viaemail, using the authorisedUserEmailVerificationCodeSend operation, is submitted here to verify the authorised user's email."}},"httpPath":"/users/verification/email/verify"}]},{"type":"group","label":"Sign-in","link":"/products/multi/openapi/sign-in","routeSlug":"/products/multi/openapi/sign-in","items":[{"label":"Sign in with password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/sign-in/loginwithpassword","routeSlug":"/products/multi/openapi/sign-in/loginwithpassword","metadata":{"seo":{"title":"Sign in with password","description":"Authenticate a user with the email and password that they provided when registering."}},"httpPath":"/login_with_password"},{"label":"Sign in via biometrics","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/sign-in/loginviabiometrics","routeSlug":"/products/multi/openapi/sign-in/loginviabiometrics","metadata":{"seo":{"title":"Sign in via biometrics","description":"Trigger a push notification and subsequent biometric authentication of a user, by providing the email that was used in the enrolment process of biometrics."}},"httpPath":"/login_via_biometrics"},{"label":"Logout","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/sign-in/logout","routeSlug":"/products/multi/openapi/sign-in/logout","metadata":{"seo":{"title":"Logout","description":"Logs out the user and terminates the session identified by the auth_token in the Authorization Header."}},"httpPath":"/logout"}]},{"type":"group","label":"Step-up Challenges","link":"/products/multi/openapi/step-up-challenges","routeSlug":"/products/multi/openapi/step-up-challenges","items":[{"label":"Issue a one-time password that can be used to step-up a token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/step-up-challenges/stepupscachallenge","routeSlug":"/products/multi/openapi/step-up-challenges/stepupscachallenge","metadata":{"seo":{"title":"Issue a one-time password that can be used to step-up a token","description":"Initiates the step-up token process by sending an SMS with an one-time-password to a device belonging to the logged-in user that was previously enrolled through /authentication_factors/otp/{channel} endpoint."}},"httpPath":"/stepup/challenges/otp/{channel}"},{"label":"Verify a step-up token using a one-time password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/step-up-challenges/stepupscaverify","routeSlug":"/products/multi/openapi/step-up-challenges/stepupscaverify","metadata":{"seo":{"title":"Verify a step-up token using a one-time password","description":"Completes the verification process for a step up token.The challenge expires after 5 minutes and the number of incorrect OTP attempts is limited to reduce the risk of fraud, in that case challenge has to be issued again."}},"httpPath":"/stepup/challenges/otp/{channel}/verify"},{"label":"Issue a push notification that can be used to step-up a token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/step-up-challenges/stepupscachallengepush","routeSlug":"/products/multi/openapi/step-up-challenges/stepupscachallengepush","metadata":{"seo":{"title":"Issue a push notification that can be used to step-up a token","description":"Initiates the step-up token process by submitting a push notification to a device belonging to the logged-in user that was previously enrolled through the /authentication_factors/push/{channel} endpoint."}},"httpPath":"/stepup/challenges/push/{channel}"}]},{"type":"group","label":"Confirmation Challenges","link":"/products/multi/openapi/confirmation-challenges","routeSlug":"/products/multi/openapi/confirmation-challenges","items":[{"label":"Issue a one-time password that can be used to verify a list of resources","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/confirmation-challenges/multiplescachallenge","routeSlug":"/products/multi/openapi/confirmation-challenges/multiplescachallenge","metadata":{"seo":{"title":"Issue a one-time password that can be used to verify a list of resources","description":"Starts the verification process for a list of resources in which a one-time password is sent to a device belonging to the logged-in user that was previously enrolled through the /authentication_factors/otp/{channel} endpoint."}},"httpPath":"/challenges/otp/{channel}"},{"label":"Verify a list of resources using a one-time password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/confirmation-challenges/multiplescaverify","routeSlug":"/products/multi/openapi/confirmation-challenges/multiplescaverify","metadata":{"seo":{"title":"Verify a list of resources using a one-time password","description":"Completes the verification process for a list of resources."}},"httpPath":"/challenges/{scaChallengeId}/otp/{channel}/verify"},{"label":"Issue a push notification that can be used to verify a list of resources","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/confirmation-challenges/multiplescachallengepush","routeSlug":"/products/multi/openapi/confirmation-challenges/multiplescachallengepush","metadata":{"seo":{"title":"Issue a push notification that can be used to verify a list of resources","description":"Starts the verification process for a list of resources in which a push notification is sent to a device belonging to the logged-in user that was previously enrolled through the /authentication_factors/push/{channel} endpoint."}},"httpPath":"/challenges/push/{channel}"}]},{"type":"group","label":"Authentication Factors","link":"/products/multi/openapi/authentication-factors","routeSlug":"/products/multi/openapi/authentication-factors","items":[{"label":"Create a password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authentication-factors/passwordcreate","routeSlug":"/products/multi/openapi/authentication-factors/passwordcreate","metadata":{"seo":{"title":"Create a password","description":"Create a new password for the user identified by the user_id path parameter."}},"httpPath":"/passwords/{user_id}/create"},{"label":"Update a password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authentication-factors/passwordupdate","routeSlug":"/products/multi/openapi/authentication-factors/passwordupdate","metadata":{"seo":{"title":"Update a password","description":"Update the password for the logged-in user."}},"httpPath":"/passwords/update"},{"label":"Validate a password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authentication-factors/passwordvalidate","routeSlug":"/products/multi/openapi/authentication-factors/passwordvalidate","metadata":{"seo":{"title":"Validate a password","description":"Check that a password adheres to all complexity checks."}},"httpPath":"/passwords/validate"},{"label":"Initiate lost password process","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authentication-factors/lostpasswordinitiate","routeSlug":"/products/multi/openapi/authentication-factors/lostpasswordinitiate","metadata":{"seo":{"title":"Initiate lost password process","description":"Initiate the lost password process."}},"httpPath":"/passwords/lost_password/start"},{"label":"Resume lost password process","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authentication-factors/lostpasswordresume","routeSlug":"/products/multi/openapi/authentication-factors/lostpasswordresume","metadata":{"seo":{"title":"Resume lost password process","description":"This is the second and final step in updating the password of a user who forgot their password."}},"httpPath":"/passwords/lost_password/resume"},{"label":"Get user authentication factors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authentication-factors/authfactorsget","routeSlug":"/products/multi/openapi/authentication-factors/authfactorsget","metadata":{"seo":{"title":"Get user authentication factors","description":"Retrieves the list of authentication factors that can be used to verify the logged-in user."}},"httpPath":"/authentication_factors"},{"label":"Enrol a user device for authentication using one-time passwords","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authentication-factors/enroldeviceusingotpstepone","routeSlug":"/products/multi/openapi/authentication-factors/enroldeviceusingotpstepone","metadata":{"seo":{"title":"Enrol a user device for authentication using one-time passwords","description":"This is the first step in enrolling the logged-in user's mobile device, where a one-time password is sent to the device."}},"httpPath":"/authentication_factors/otp/{channel}"},{"label":"Verify enrolment of a user device for authentication using one-time passwords","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authentication-factors/enroldeviceusingotpsteptwo","routeSlug":"/products/multi/openapi/authentication-factors/enroldeviceusingotpsteptwo","metadata":{"seo":{"title":"Verify enrolment of a user device for authentication using one-time passwords","description":"The second step in enrolling the logged-in user (root or authorised user) to use one-time-passwords to enable verification of transactions.The challenge expires after 5 minutes and the number of incorrect OTP attempts is limited to reduce the risk of fraud, in that case challenge has to be issued again."}},"httpPath":"/authentication_factors/otp/{channel}/verify"},{"label":"Enrol a user device for authentication using push notifications","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authentication-factors/enroldeviceusingpush","routeSlug":"/products/multi/openapi/authentication-factors/enroldeviceusingpush","metadata":{"seo":{"title":"Enrol a user device for authentication using push notifications","description":"This is the first step in enrolling the logged-in user's mobile device, where a push notification is sent to the device."}},"httpPath":"/authentication_factors/push/{channel}"},{"label":"Unlink a user device for authentication using push notifications","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authentication-factors/unlinkdeviceusingpush","routeSlug":"/products/multi/openapi/authentication-factors/unlinkdeviceusingpush","metadata":{"seo":{"title":"Unlink a user device for authentication using push notifications","description":"Unlink a user device for authentication using push notifications"}},"httpPath":"/authentication_factors/push/{channel}"}]},{"type":"separator","label":"Access"},{"type":"group","label":"Access Tokens","link":"/products/multi/openapi/access-tokens","routeSlug":"/products/multi/openapi/access-tokens","items":[{"label":"Acquire a new access token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/access-tokens/requestaccesstoken","routeSlug":"/products/multi/openapi/access-tokens/requestaccesstoken","metadata":{"seo":{"title":"Acquire a new access token","description":"This API endpoint accepts a POST request with an auth_token parameter and returns an access_token that grants authorized access to additional resources within the API, with a different expiration time and unique signature."}},"httpPath":"/access_token"}]},{"type":"separator","label":"Customer Settings"},{"type":"group","label":"Customer Data & Due Diligence","link":"/products/multi/openapi/customer-data-and-due-diligence","routeSlug":"/products/multi/openapi/customer-data-and-due-diligence","items":[{"label":"Get a corporate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/customer-data-and-due-diligence/corporateget","routeSlug":"/products/multi/openapi/customer-data-and-due-diligence/corporateget","metadata":{"seo":{"title":"Get a corporate","description":"Retrieve the details of the logged-in corporate."}},"httpPath":"/corporates"},{"label":"Update a corporate","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/customer-data-and-due-diligence/corporateupdate","routeSlug":"/products/multi/openapi/customer-data-and-due-diligence/corporateupdate","metadata":{"seo":{"title":"Update a corporate","description":"Update the details of the logged-in corporate identity."}},"httpPath":"/corporates"},{"label":"Start KYB for a corporate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/customer-data-and-due-diligence/corporatekybstart","routeSlug":"/products/multi/openapi/customer-data-and-due-diligence/corporatekybstart","metadata":{"seo":{"title":"Start KYB for a corporate","description":"Corporates need to complete due diligence (KYB) before they can create instruments and perform transactions."}},"httpPath":"/corporates/kyb"},{"label":"Get KYB for a corporate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/customer-data-and-due-diligence/corporatekybget","routeSlug":"/products/multi/openapi/customer-data-and-due-diligence/corporatekybget","metadata":{"seo":{"title":"Get KYB for a corporate","description":"Returns the KYB status for the logged-in corporate."}},"httpPath":"/corporates/kyb"},{"label":"Get a consumer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/customer-data-and-due-diligence/consumerget","routeSlug":"/products/multi/openapi/customer-data-and-due-diligence/consumerget","metadata":{"seo":{"title":"Get a consumer","description":"Retrieve the details of the logged-in Consumer."}},"httpPath":"/consumers"},{"label":"Update a consumer","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/customer-data-and-due-diligence/consumerupdate","routeSlug":"/products/multi/openapi/customer-data-and-due-diligence/consumerupdate","metadata":{"seo":{"title":"Update a consumer","description":"Update the details of the logged-in consumer identity."}},"httpPath":"/consumers"},{"label":"Start KYC for a consumer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/customer-data-and-due-diligence/consumerkycstart","routeSlug":"/products/multi/openapi/customer-data-and-due-diligence/consumerkycstart","metadata":{"seo":{"title":"Start KYC for a consumer","description":"Consumers need to complete due diligence (KYC) before they can create instruments and fund transaction."}},"httpPath":"/consumers/kyc"},{"label":"Get KYC for a consumer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/customer-data-and-due-diligence/consumerkycget","routeSlug":"/products/multi/openapi/customer-data-and-due-diligence/consumerkycget","metadata":{"seo":{"title":"Get KYC for a consumer","description":"Returns the KYC status for the logged-in consumer."}},"httpPath":"/consumers/kyc"}]},{"type":"group","label":"Authorised Signatories","link":"/products/multi/openapi/authorised-signatories","routeSlug":"/products/multi/openapi/authorised-signatories","items":[{"label":"Send email verification code to Corporate root user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authorised-signatories/corporaterootuseremailverificationcodesend","routeSlug":"/products/multi/openapi/authorised-signatories/corporaterootuseremailverificationcodesend","metadata":{"seo":{"title":"Send email verification code to Corporate root user","description":"The first step in verifying a root user's email. The root user whose email address is to be verified is sent an email containing a randomly generated code."}},"httpPath":"/corporates/verification/email/send"},{"label":"Verify email of Corporate root user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authorised-signatories/corporaterootuseremailverify","routeSlug":"/products/multi/openapi/authorised-signatories/corporaterootuseremailverify","metadata":{"seo":{"title":"Verify email of Corporate root user","description":"The second step in verifying the root user's email. The randomly generated code sent to the root user viaemail, using the corporateRootUserEmailVerificationCodeSend operation, is submitted here to verify the root user's email."}},"httpPath":"/corporates/verification/email/verify"},{"label":"Send email verification code to Consumer root user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authorised-signatories/consumerrootuseremailverificationcodesend","routeSlug":"/products/multi/openapi/authorised-signatories/consumerrootuseremailverificationcodesend","metadata":{"seo":{"title":"Send email verification code to Consumer root user","description":"The first step in verifying a root user's email. The root user whose email address is to be verified is sent an email containing a randomly generated code."}},"httpPath":"/consumers/verification/email/send"},{"label":"Verify email of Consumer root user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authorised-signatories/consumerrootuseremailverify","routeSlug":"/products/multi/openapi/authorised-signatories/consumerrootuseremailverify","metadata":{"seo":{"title":"Verify email of Consumer root user","description":"The second step in verifying the root user's email. The randomly generated code sent to the root user viaemail, using the consumerRootUserEmailVerificationCodeSend operation, is submitted here to verify the root user's email."}},"httpPath":"/consumers/verification/email/verify"}]},{"type":"group","label":"Authorised Users","link":"/products/multi/openapi/authorised-users","routeSlug":"/products/multi/openapi/authorised-users","items":[{"label":"Link an existing user to your identity","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authorised-users/userlink","routeSlug":"/products/multi/openapi/authorised-users/userlink","metadata":{"seo":{"title":"Link an existing user to your identity","description":"Links a user that already exists on another identity to your identity."}},"httpPath":"/users/{user_id}/link"},{"label":"Deactivate an authorised user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authorised-users/userdeactivate","routeSlug":"/products/multi/openapi/authorised-users/userdeactivate","metadata":{"seo":{"title":"Deactivate an authorised user","description":"De-activate the user identified by the user_id path parameter."}},"httpPath":"/users/{user_id}/deactivate"},{"label":"Reactivate an authorised user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authorised-users/useractivate","routeSlug":"/products/multi/openapi/authorised-users/useractivate","metadata":{"seo":{"title":"Reactivate an authorised user","description":"Re-activate the user identified by the user_id path parameter."}},"httpPath":"/users/{user_id}/activate"},{"label":"Start KYC to elevate an authorised user to signatory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authorised-users/userkyc","routeSlug":"/products/multi/openapi/authorised-users/userkyc","metadata":{"seo":{"title":"Start KYC to elevate an authorised user to signatory","description":"Perform the kyc for a corporate user."}},"httpPath":"/users/kyc"}]},{"type":"group","label":"Trusted Payees","link":"/products/multi/openapi/trusted-payees","routeSlug":"/products/multi/openapi/trusted-payees","items":[{"label":"Add payees","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/trusted-payees/beneficiarybatchcreate","routeSlug":"/products/multi/openapi/trusted-payees/beneficiarybatchcreate","metadata":{"seo":{"title":"Add payees","description":"Payees (previously \"beneficiaries\"). Create one or more payees for the logged-in corporate or consumer identity."}},"httpPath":"/beneficiaries"},{"label":"Get all payees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/trusted-payees/beneficiariesget","routeSlug":"/products/multi/openapi/trusted-payees/beneficiariesget","metadata":{"seo":{"title":"Get all payees","description":"Payees (previously \"beneficiaries\"). Retrieves the payees that match the query parameters."}},"httpPath":"/beneficiaries"},{"label":"Remove payees","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/trusted-payees/beneficiarybatchremove","routeSlug":"/products/multi/openapi/trusted-payees/beneficiarybatchremove","metadata":{"seo":{"title":"Remove payees","description":"Payees (previously \"beneficiaries\"). Removes one or more payees from the payees list identified by the id path parameter used in the array."}},"httpPath":"/beneficiaries/remove"},{"label":"Get a payee","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/trusted-payees/beneficiaryget","routeSlug":"/products/multi/openapi/trusted-payees/beneficiaryget","metadata":{"seo":{"title":"Get a payee","description":"Payees (previously \"beneficiaries\"). Retrieves a payee identified by the id path parameter."}},"httpPath":"/beneficiaries/{id}"},{"label":"Get all payee batches","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/trusted-payees/beneficiarybatchesget","routeSlug":"/products/multi/openapi/trusted-payees/beneficiarybatchesget","metadata":{"seo":{"title":"Get all payee batches","description":"Payees (previously \"beneficiaries\"). Retrieves all payee batches matching the query parameters and that belong to the logged-in identity."}},"httpPath":"/beneficiaries/batch"},{"label":"Get a batch of payees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/trusted-payees/beneficiarybatchget","routeSlug":"/products/multi/openapi/trusted-payees/beneficiarybatchget","metadata":{"seo":{"title":"Get a batch of payees","description":"Payees (previously \"beneficiaries\"). Retrieves the details of a payee batch identified by the batchId path parameter."}},"httpPath":"/beneficiaries/batch/{id}"},{"label":"Issue OTP to verify batch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/trusted-payees/beneficiarybatchscachallenge","routeSlug":"/products/multi/openapi/trusted-payees/beneficiarybatchscachallenge","metadata":{"seo":{"title":"Issue OTP to verify batch","description":"Payees (previously \"beneficiaries\"). Starts the verification process for updating the payees batch in which a one-time password is sent to a device belonging to the logged-in user that was previously enrolled through the /authentication_factors/otp/{channel} endpoint."}},"httpPath":"/beneficiaries/batch/{id}/challenges/otp/{channel}"},{"label":"Verify batch using OTP","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/trusted-payees/beneficiarybatchscaverify","routeSlug":"/products/multi/openapi/trusted-payees/beneficiarybatchscaverify","metadata":{"seo":{"title":"Verify batch using OTP","description":"Payees (previously \"beneficiaries\"). Completes the verification process for updating the payee batch."}},"httpPath":"/beneficiaries/batch/{id}/challenges/otp/{channel}/verify"},{"label":"Issue push to verify batch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/trusted-payees/beneficiarybatchscachallengepush","routeSlug":"/products/multi/openapi/trusted-payees/beneficiarybatchscachallengepush","metadata":{"seo":{"title":"Issue push to verify batch","description":"Payees (previously \"beneficiaries\"). Starts the verification process for updating a payee batch in which a push notification is sent to a device belonging to the logged-in user that was previously enrolled through the /authentication_factors/push/{channel} endpoint."}},"httpPath":"/beneficiaries/batch/{id}/challenges/push/{channel}"}]},{"type":"separator","label":"Instruments"},{"type":"group","label":"Managed Accounts","link":"/products/multi/openapi/managed-accounts","routeSlug":"/products/multi/openapi/managed-accounts","items":[{"label":"Get all managed accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-accounts/managedaccountsget","routeSlug":"/products/multi/openapi/managed-accounts/managedaccountsget","metadata":{"seo":{"title":"Get all managed accounts","description":"Retrieves all managed accounts belonging to the logged-in identity."}},"httpPath":"/managed_accounts"},{"label":"Create a managed account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-accounts/managedaccountcreate","routeSlug":"/products/multi/openapi/managed-accounts/managedaccountcreate","metadata":{"seo":{"title":"Create a managed account","description":"Creates a managed account for the consumer or corporate identity. The Managed Account Profile (configured in the Multi Portal) specified determines the behavior and restrictions that the managed account will have.\""}},"httpPath":"/managed_accounts"},{"label":"Get a managed account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-accounts/managedaccountget","routeSlug":"/products/multi/openapi/managed-accounts/managedaccountget","metadata":{"seo":{"title":"Get a managed account","description":"Fetch the managed account identified by the id in path."}},"httpPath":"/managed_accounts/{id}"},{"label":"Update a managed account","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-accounts/managedaccountupdate","routeSlug":"/products/multi/openapi/managed-accounts/managedaccountupdate","metadata":{"seo":{"title":"Update a managed account","description":"Update the details for the managed account identified by the id in the path."}},"httpPath":"/managed_accounts/{id}"},{"label":"Upgrade a managed account with IBAN","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-accounts/managedaccountsibanupgrade","routeSlug":"/products/multi/openapi/managed-accounts/managedaccountsibanupgrade","metadata":{"seo":{"title":"Upgrade a managed account with IBAN","description":"Assign an IBAN to a Managed Account."}},"httpPath":"/managed_accounts/{id}/iban"},{"label":"Get a managed account IBAN","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-accounts/managedaccountibanget","routeSlug":"/products/multi/openapi/managed-accounts/managedaccountibanget","metadata":{"seo":{"title":"Get a managed account IBAN","description":"Fetch the IBAN details associated with the Managed Account identified by the id in the path."}},"httpPath":"/managed_accounts/{id}/iban"},{"label":"Block a managed account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-accounts/managedaccountblock","routeSlug":"/products/multi/openapi/managed-accounts/managedaccountblock","metadata":{"seo":{"title":"Block a managed account","description":"Temporarily blocks a managed account."}},"httpPath":"/managed_accounts/{id}/block"},{"label":"Unblock a managed account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-accounts/managedaccountunblock","routeSlug":"/products/multi/openapi/managed-accounts/managedaccountunblock","metadata":{"seo":{"title":"Unblock a managed account","description":"Unblocks the managed account identified by the id path parameter.The managed account must have state.blockedReason as USER so that it can be unblocked.If the managed account was blocked by SYSTEM, users cannot unblock it."}},"httpPath":"/managed_accounts/{id}/unblock"},{"label":"Get a managed account statement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-accounts/managedaccountstatement","routeSlug":"/products/multi/openapi/managed-accounts/managedaccountstatement","metadata":{"seo":{"title":"Get a managed account statement","description":"Returns a statement for the managed account identified by the id path parameter."}},"httpPath":"/managed_accounts/{id}/statement"},{"label":"Get transaction activity for a managed account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-accounts/managedaccounttransactionsget","routeSlug":"/products/multi/openapi/managed-accounts/managedaccounttransactionsget","metadata":{"seo":{"title":"Get transaction activity for a managed account","description":"Returns all transactional activity on the managed account identified by the id path parameter."}},"httpPath":"/managed_accounts/{id}/transactions"},{"label":"Get a specific transaction for a managed account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-accounts/managedaccounttransactionget","routeSlug":"/products/multi/openapi/managed-accounts/managedaccounttransactionget","metadata":{"seo":{"title":"Get a specific transaction for a managed account","description":"Returns a specific transaction on the managed account."}},"httpPath":"/managed_accounts/{id}/transactions/{transactionId}"},{"label":"Remove a managed account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-accounts/managedaccountremove","routeSlug":"/products/multi/openapi/managed-accounts/managedaccountremove","metadata":{"seo":{"title":"Remove a managed account","description":"Destroys the managed account identified by the id path parameter. Unlike block, this action is not reversible."}},"httpPath":"/managed_accounts/{id}/remove"},{"label":"Get a managed account statement (legacy)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-accounts/managedaccountstatementdeprecated","routeSlug":"/products/multi/openapi/managed-accounts/managedaccountstatementdeprecated","metadata":{"seo":{"title":"Get a managed account statement (legacy)","description":"Deprecated in favour of GET /managed_accounts/{id}/statements, which provides an authoritative, immutable statement of record for an instrument over a period, as explained in our changelog."}},"httpPath":"/deprecated/managed_accounts/{id}/statement"}]},{"type":"group","label":"Managed Cards","link":"/products/multi/openapi/managed-cards","routeSlug":"/products/multi/openapi/managed-cards","items":[{"label":"Create a managed card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardcreate","routeSlug":"/products/multi/openapi/managed-cards/managedcardcreate","metadata":{"seo":{"title":"Create a managed card","description":"Creates a managed card for the consumer or corporate identity. The Managed Card Profile (configured in the Multi Portal) specified determines the behaviour and restrictions that the managed card will have."}},"httpPath":"/managed_cards"},{"label":"Get all managed cards","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardsget","routeSlug":"/products/multi/openapi/managed-cards/managedcardsget","metadata":{"seo":{"title":"Get all managed cards","description":"Fetch cards matching the search criteria provided."}},"httpPath":"/managed_cards"},{"label":"Get a managed card","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardget","routeSlug":"/products/multi/openapi/managed-cards/managedcardget","metadata":{"seo":{"title":"Get a managed card","description":"Returns all details of the managed card identified by the id path parameter."}},"httpPath":"/managed_cards/{id}"},{"label":"Update a managed card","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardupdate","routeSlug":"/products/multi/openapi/managed-cards/managedcardupdate","metadata":{"seo":{"title":"Update a managed card","description":"Update the details of the managed card identified by the id path parameter."}},"httpPath":"/managed_cards/{id}"},{"label":"Block a managed card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardblock","routeSlug":"/products/multi/openapi/managed-cards/managedcardblock","metadata":{"seo":{"title":"Block a managed card","description":"Blocks the managed card identified by the id path parameter. This is a reversible action and the card can be unblocked using the managedCardUnblock operation."}},"httpPath":"/managed_cards/{id}/block"},{"label":"Unblock a managed card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardunblock","routeSlug":"/products/multi/openapi/managed-cards/managedcardunblock","metadata":{"seo":{"title":"Unblock a managed card","description":"Unblocks the managed card identified by the id path parameter.The managed card must have state.blockedReason as USER so that it can be unblocked.If the managed card was blocked by SYSTEM, users cannot unblock it."}},"httpPath":"/managed_cards/{id}/unblock"},{"label":"Remove a managed card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardremove","routeSlug":"/products/multi/openapi/managed-cards/managedcardremove","metadata":{"seo":{"title":"Remove a managed card","description":"Destroys the managed card identified by the id path parameter. Unlike block, this action is not reversible."}},"httpPath":"/managed_cards/{id}/remove"},{"label":"Get a managed card statement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardstatement","routeSlug":"/products/multi/openapi/managed-cards/managedcardstatement","metadata":{"seo":{"title":"Get a managed card statement","description":"Returns a statement for the managed card identified by the id path parameter."}},"httpPath":"/managed_cards/{id}/statement"},{"label":"Get transaction activity for a managed card","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardtransactionsget","routeSlug":"/products/multi/openapi/managed-cards/managedcardtransactionsget","metadata":{"seo":{"title":"Get transaction activity for a managed card","description":"Returns all transactional activity on the managed card identified by the id path parameter."}},"httpPath":"/managed_cards/{id}/transactions"},{"label":"Get a specific transaction for a managed card","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardtransactionget","routeSlug":"/products/multi/openapi/managed-cards/managedcardtransactionget","metadata":{"seo":{"title":"Get a specific transaction for a managed card","description":"Returns a specific transaction on the managed card."}},"httpPath":"/managed_cards/{id}/transactions/{transactionId}"},{"label":"Upgrade a card to physical","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardphysicalupgrade","routeSlug":"/products/multi/openapi/managed-cards/managedcardphysicalupgrade","metadata":{"seo":{"title":"Upgrade a card to physical","description":"Upgrades the virtual card identified by the id path parameter to physical."}},"httpPath":"/managed_cards/{id}/physical"},{"label":"Activate a physical card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardphysicalactivate","routeSlug":"/products/multi/openapi/managed-cards/managedcardphysicalactivate","metadata":{"seo":{"title":"Activate a physical card","description":"Activates the physical card identified by the id path paramter."}},"httpPath":"/managed_cards/{id}/physical/activate"},{"label":"Get PIN for a physical card","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardphysicalpinget","routeSlug":"/products/multi/openapi/managed-cards/managedcardphysicalpinget","metadata":{"seo":{"title":"Get PIN for a physical card","description":"Retrieves the PIN of the physical card identified by the id path parameter."}},"httpPath":"/managed_cards/{id}/physical/pin"},{"label":"Unblock PIN for a physical card","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardphysicalpinunblock","routeSlug":"/products/multi/openapi/managed-cards/managedcardphysicalpinunblock","metadata":{"seo":{"title":"Unblock PIN for a physical card","description":"Physical cards can be marked as pinBlocked if there are too many failed PIN attempts."}},"httpPath":"/managed_cards/{id}/physical/pin/unblock"},{"label":"Replace a damaged physical card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardphysicalreplacedamaged","routeSlug":"/products/multi/openapi/managed-cards/managedcardphysicalreplacedamaged","metadata":{"seo":{"title":"Replace a damaged physical card","description":"Report as damaged, and replace the physical card identified by the id path parameter."}},"httpPath":"/managed_cards/{id}/physical/replace_damaged"},{"label":"Report a physical card as lost","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardphysicalreportlost","routeSlug":"/products/multi/openapi/managed-cards/managedcardphysicalreportlost","metadata":{"seo":{"title":"Report a physical card as lost","description":"Report the physical card identified by the id path parameter as lost. This will deactivate the instrument and a new card will need to be requested."}},"httpPath":"/managed_cards/{id}/physical/report_lost"},{"label":"Report a physical card as stolen","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardphysicalreportstolen","routeSlug":"/products/multi/openapi/managed-cards/managedcardphysicalreportstolen","metadata":{"seo":{"title":"Report a physical card as stolen","description":"Report the physical card identified by the id path parameter as stolen. This will destroy the instrument and a new replacement card will need to be requested."}},"httpPath":"/managed_cards/{id}/physical/report_stolen"},{"label":"Replace a lost or stolen physical card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardphysicalreplacelostorstolen","routeSlug":"/products/multi/openapi/managed-cards/managedcardphysicalreplacelostorstolen","metadata":{"seo":{"title":"Replace a lost or stolen physical card","description":"Issue a replacement for the physical card, identified by the id path parameter, that has already been reported as lost or stolen."}},"httpPath":"/managed_cards/{id}/physical/replace_lost_stolen"},{"label":"Reset contactless limit for a physical card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardphysicalcontactlesslimitreset","routeSlug":"/products/multi/openapi/managed-cards/managedcardphysicalcontactlesslimitreset","metadata":{"seo":{"title":"Reset contactless limit for a physical card","description":"For security purposes, the cardholder needs to provide the PIN after a number of contactless purchases. Use this operation to reset the physical card's contactless limit. The contactless limit can only be reset for physical cards having the wearable form factor."}},"httpPath":"/managed_cards/{id}/physical/contactless_limit/reset"},{"label":"Get a managed card statement (legacy)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardstatementdeprecated","routeSlug":"/products/multi/openapi/managed-cards/managedcardstatementdeprecated","metadata":{"seo":{"title":"Get a managed card statement (legacy)","description":"Deprecated in favour of GET /managed_cards/{id}/statements, which provides an authoritative, immutable statement of record for an instrument over a period, as explained in our changelog."}},"httpPath":"/deprecated/managed_cards/{id}/statement"}]},{"type":"separator","label":"Funds Management"},{"type":"group","label":"Transfers","link":"/products/multi/openapi/transfers","routeSlug":"/products/multi/openapi/transfers","items":[{"label":"Create a transfer transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/transfers/transfercreate","routeSlug":"/products/multi/openapi/transfers/transfercreate","metadata":{"seo":{"title":"Create a transfer transaction","description":"Transfers funds between managed accounts and managed cards belonging to the same corporate or consumer identity."}},"httpPath":"/transfers"},{"label":"Get all transfer transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/transfers/transfersget","routeSlug":"/products/multi/openapi/transfers/transfersget","metadata":{"seo":{"title":"Get all transfer transactions","description":"Retrieves all the transfer transactions performed by the logged-in identity."}},"httpPath":"/transfers"},{"label":"Cancel transfer transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/transfers/transfercancel","routeSlug":"/products/multi/openapi/transfers/transfercancel","metadata":{"seo":{"title":"Cancel transfer transactions","description":"Cancels transfers that are scheduled to be executed in the future."}},"httpPath":"/transfers/bulk/cancel"},{"label":"Get a transfer transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/transfers/transferget","routeSlug":"/products/multi/openapi/transfers/transferget","metadata":{"seo":{"title":"Get a transfer transaction","description":"Retrieve the transfer transaction identified by the id path parameter."}},"httpPath":"/transfers/{id}"}]},{"type":"group","label":"Transaction Activity","link":"/products/multi/openapi/transaction-activity","routeSlug":"/products/multi/openapi/transaction-activity","items":[{"label":"Get all transaction activity","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/transaction-activity/transactionsget","routeSlug":"/products/multi/openapi/transaction-activity/transactionsget","metadata":{"seo":{"title":"Get all transaction activity","description":"Returns all transactional activity across all managed accounts and managed cards."}},"httpPath":"/transactions"}]},{"type":"separator","label":"External Payments"},{"type":"group","label":"Incoming Wire Transfers","link":"/products/multi/openapi/incoming-wire-transfers","routeSlug":"/products/multi/openapi/incoming-wire-transfers","items":[{"label":"Get all incoming wire transfers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/incoming-wire-transfers/incomingwiretransfersget","routeSlug":"/products/multi/openapi/incoming-wire-transfers/incomingwiretransfersget","metadata":{"seo":{"title":"Get all incoming wire transfers","description":"Returns all incoming wire transfers for the authenticated identity."}},"httpPath":"/incoming_wire_transfers"},{"label":"Get an incoming wire transfer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/incoming-wire-transfers/incomingwiretransferget","routeSlug":"/products/multi/openapi/incoming-wire-transfers/incomingwiretransferget","metadata":{"seo":{"title":"Get an incoming wire transfer","description":"Returns a specific incoming wire transfer."}},"httpPath":"/incoming_wire_transfers/{id}"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Approve or reject incoming wire transfers","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/multi/openapi/incoming-wire-transfers/banktransferinforwarding","routeSlug":"/products/multi/openapi/incoming-wire-transfers/banktransferinforwarding","metadata":{"seo":{"title":"Approve or reject incoming wire transfers","description":"Approve or reject incoming wire transfers"}},"httpPath":"/bank_transfers_in/authorisation_request"}]},{"type":"group","label":"Outgoing Wire Transfers","link":"/products/multi/openapi/outgoing-wire-transfers","routeSlug":"/products/multi/openapi/outgoing-wire-transfers","items":[{"label":"Create an outgoing wire transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransfercreate","routeSlug":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransfercreate","metadata":{"seo":{"title":"Create an outgoing wire transfer","description":"Transfers funds from managed accounts to an external bank account."}},"httpPath":"/outgoing_wire_transfers"},{"label":"Get all outgoing wire transfer transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransfersget","routeSlug":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransfersget","metadata":{"seo":{"title":"Get all outgoing wire transfer transactions","description":"Retrieves all the outgoing wire transfer transactions performed by the logged-in identity."}},"httpPath":"/outgoing_wire_transfers"},{"label":"Get an outgoing wire transfer transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransferget","routeSlug":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransferget","metadata":{"seo":{"title":"Get an outgoing wire transfer transaction","description":"Retrieves the outgoing wire transfer identified by the id path parameter."}},"httpPath":"/outgoing_wire_transfers/{id}"},{"label":"Update the beneficiary name of an outgoing wire transfer","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransferupdatebeneficiaryname","routeSlug":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransferupdatebeneficiaryname","metadata":{"seo":{"title":"Update the beneficiary name of an outgoing wire transfer","description":"Update the beneficiary name of an OWT in PENDING_CONFIRMATION state. Clears and re-runs CoP/VoP validation with the new name."}},"httpPath":"/outgoing_wire_transfers/{id}"},{"label":"Get an outgoing wire transfer payment confirmation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransferpaymentconfirmation","routeSlug":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransferpaymentconfirmation","metadata":{"seo":{"title":"Get an outgoing wire transfer payment confirmation","description":"Returns a payment-confirmation PDF for the completed outgoing wire transfer identified by the id path parameter. If the transfer was subsequently returned, the document also includes the return details."}},"httpPath":"/outgoing_wire_transfers/{id}/payment_confirmation"},{"label":"Cancel an outgoing wire transfer transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransfersinglecancel","routeSlug":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransfersinglecancel","metadata":{"seo":{"title":"Cancel an outgoing wire transfer transaction","description":"Cancel the outgoing wire transfer identified by the id path parameter."}},"httpPath":"/outgoing_wire_transfers/{id}/cancel"},{"label":"Confirm an outgoing wire transfer transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransferconfirm","routeSlug":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransferconfirm","metadata":{"seo":{"title":"Confirm an outgoing wire transfer transaction","description":"Confirm the outgoing wire transfer identified by the id path parameter."}},"httpPath":"/outgoing_wire_transfers/{id}/confirm"},{"label":"Issue a one-time password that can be used to verify an outgoing wire transfer","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransferscachallenge","routeSlug":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransferscachallenge","metadata":{"seo":{"title":"Issue a one-time password that can be used to verify an outgoing wire transfer","description":"Deprecated in favour of Challenges endpoints"}},"httpPath":"/outgoing_wire_transfers/{id}/challenges/otp/{channel}"},{"label":"Verify an outgoing wire transfer using a one-time password","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransferscaverify","routeSlug":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransferscaverify","metadata":{"seo":{"title":"Verify an outgoing wire transfer using a one-time password","description":"Deprecated in favour of Challenges endpoints"}},"httpPath":"/outgoing_wire_transfers/{id}/challenges/otp/{channel}/verify"},{"label":"Issue a push notification that can be used to verify an outgoing wire transfer","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransferscachallengepush","routeSlug":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransferscachallengepush","metadata":{"seo":{"title":"Issue a push notification that can be used to verify an outgoing wire transfer","description":"Deprecated in favour of Challenges endpoints"}},"httpPath":"/outgoing_wire_transfers/{id}/challenges/push/{channel}"}]},{"type":"group","label":"Correspondent Bank Transfers","link":"/products/multi/openapi/correspondent-bank-transfers","routeSlug":"/products/multi/openapi/correspondent-bank-transfers","items":[{"label":"Create a correspondent bank transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/correspondent-bank-transfers/correspondentbanktransfercreate","routeSlug":"/products/multi/openapi/correspondent-bank-transfers/correspondentbanktransfercreate","metadata":{"seo":{"title":"Create a correspondent bank transfer","description":"Creates an outgoing wire transfer on behalf of an originator (correspondent banking)."}},"httpPath":"/correspondent_bank_transfers"},{"label":"Get all correspondent bank transfer transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/correspondent-bank-transfers/correspondentbanktransfersget","routeSlug":"/products/multi/openapi/correspondent-bank-transfers/correspondentbanktransfersget","metadata":{"seo":{"title":"Get all correspondent bank transfer transactions","description":"Retrieves all correspondent bank transfer transactions."}},"httpPath":"/correspondent_bank_transfers"},{"label":"Get a correspondent bank transfer transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/correspondent-bank-transfers/correspondentbanktransferget","routeSlug":"/products/multi/openapi/correspondent-bank-transfers/correspondentbanktransferget","metadata":{"seo":{"title":"Get a correspondent bank transfer transaction","description":"Retrieves the correspondent bank transfer identified by the id path parameter."}},"httpPath":"/correspondent_bank_transfers/{id}"},{"label":"Cancel a correspondent bank transfer transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/correspondent-bank-transfers/correspondentbanktransfercancel","routeSlug":"/products/multi/openapi/correspondent-bank-transfers/correspondentbanktransfercancel","metadata":{"seo":{"title":"Cancel a correspondent bank transfer transaction","description":"Cancel the correspondent bank transfer identified by the id path parameter."}},"httpPath":"/correspondent_bank_transfers/{id}/cancel"},{"label":"Confirm a correspondent bank transfer transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/correspondent-bank-transfers/correspondentbanktransferconfirm","routeSlug":"/products/multi/openapi/correspondent-bank-transfers/correspondentbanktransferconfirm","metadata":{"seo":{"title":"Confirm a correspondent bank transfer transaction","description":"Confirm the correspondent bank transfer identified by the id path parameter."}},"httpPath":"/correspondent_bank_transfers/{id}/confirm"}]},{"type":"separator","label":"Card Payments"},{"type":"group","label":"Card Payments","link":"/products/multi/openapi/card-payments","routeSlug":"/products/multi/openapi/card-payments","items":[{"label":"Get all card payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/card-payments/cardpaymentsget","routeSlug":"/products/multi/openapi/card-payments/cardpaymentsget","metadata":{"seo":{"title":"Get all card payments","description":"Returns the aggregated card payments for the logged-in identity. A CardPayment represents the full lifecycle of a card payment (authorisation + settlements + optional reversal/expiry/refund/original credit) as a single business-level entity."}},"httpPath":"/card_payments"},{"label":"Get a single card payment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/card-payments/cardpaymentget","routeSlug":"/products/multi/openapi/card-payments/cardpaymentget","metadata":{"seo":{"title":"Get a single card payment","description":"Returns a single card payment by id."}},"httpPath":"/card_payments/{id}"},{"label":"Get all card payment events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/card-payments/cardpaymenteventsget","routeSlug":"/products/multi/openapi/card-payments/cardpaymenteventsget","metadata":{"seo":{"title":"Get all card payment events","description":"Returns a flat, chronological list of card payment events across one or more card payments. Each entry carries the event plus the parent CardPayment context (card, merchant, group)."}},"httpPath":"/card_payment_events"}]},{"type":"group","label":"Spend Controls","link":"/products/multi/openapi/spend-controls","routeSlug":"/products/multi/openapi/spend-controls","items":[{"label":"Get all spend rules for a managed card","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/spend-controls/managedcardspendrulesget","routeSlug":"/products/multi/openapi/spend-controls/managedcardspendrulesget","metadata":{"seo":{"title":"Get all spend rules for a managed card","description":"Fetch the list of spend rules associated with the managed card identified by the id path parameter."}},"httpPath":"/managed_cards/{id}/spend_rules"},{"label":"Create spend rules for a managed card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/spend-controls/managedcardspendrulescreate","routeSlug":"/products/multi/openapi/spend-controls/managedcardspendrulescreate","metadata":{"seo":{"title":"Create spend rules for a managed card","description":"Create the spend rules associated with the managed card identified by the id path parameter."}},"httpPath":"/managed_cards/{id}/spend_rules"},{"label":"Update spend rules for a managed card","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/spend-controls/managedcardspendrulesupdate","routeSlug":"/products/multi/openapi/spend-controls/managedcardspendrulesupdate","metadata":{"seo":{"title":"Update spend rules for a managed card","description":"Must be user after a POST, to update individual spend rules associated with the managed card identified by the id path parameter."}},"httpPath":"/managed_cards/{id}/spend_rules"},{"label":"Delete all spend rules for a managed card","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/spend-controls/managedcardspendrulesdelete","routeSlug":"/products/multi/openapi/spend-controls/managedcardspendrulesdelete","metadata":{"seo":{"title":"Delete all spend rules for a managed card","description":"Remove all spend rules associated with the managed card identified by the id path parameter."}},"httpPath":"/managed_cards/{id}/spend_rules"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Approve or reject card payments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/multi/openapi/spend-controls/managed_cards_authorisation_forwarding","routeSlug":"/products/multi/openapi/spend-controls/managed_cards_authorisation_forwarding","metadata":{"seo":{"title":"Approve or reject card payments","description":"Receive purchase authorisation events and choose if to approve or decline them by replying to the event."}},"httpPath":"/managed_cards/authorisation_request"}]},{"type":"separator","label":"In-Platform Payments"},{"type":"group","label":"Sends","link":"/products/multi/openapi/sends","routeSlug":"/products/multi/openapi/sends","items":[{"label":"Create a send transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/sends/sendcreate","routeSlug":"/products/multi/openapi/sends/sendcreate","metadata":{"seo":{"title":"Create a send transaction","description":"Sends funds between managed accounts and managed cards belonging to different corporate or consumer identities."}},"httpPath":"/sends"},{"label":"Get all send transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/sends/sendsget","routeSlug":"/products/multi/openapi/sends/sendsget","metadata":{"seo":{"title":"Get all send transactions","description":"Retrieves all the send transactions performed by the logged-in identity."}},"httpPath":"/sends"},{"label":"Get a send transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/sends/sendget","routeSlug":"/products/multi/openapi/sends/sendget","metadata":{"seo":{"title":"Get a send transaction","description":"Retrieve the send transaction identified by the id path parameter."}},"httpPath":"/sends/{id}"},{"label":"Cancel a send transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/sends/sendsinglecancel","routeSlug":"/products/multi/openapi/sends/sendsinglecancel","metadata":{"seo":{"title":"Cancel a send transaction","description":"Cancel the send transaction identified by the id path parameter."}},"httpPath":"/sends/{id}/cancel"},{"label":"Issue a one-time password that can be used to verify a send","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/sends/sendscachallenge","routeSlug":"/products/multi/openapi/sends/sendscachallenge","metadata":{"seo":{"title":"Issue a one-time password that can be used to verify a send","description":"Deprecated in favour of Challenges endpoints"}},"httpPath":"/sends/{id}/challenges/otp/{channel}"},{"label":"Verify a send using a one-time password","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/sends/sendscaverify","routeSlug":"/products/multi/openapi/sends/sendscaverify","metadata":{"seo":{"title":"Verify a send using a one-time password","description":"Deprecated in favour of Challenges endpoints"}},"httpPath":"/sends/{id}/challenges/otp/{channel}/verify"},{"label":"Issue a push notification that can be used to verify Send transaction","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/sends/sendscachallengepush","routeSlug":"/products/multi/openapi/sends/sendscachallengepush","metadata":{"seo":{"title":"Issue a push notification that can be used to verify Send transaction","description":"Deprecated in favour of Challenges endpoints"}},"httpPath":"/sends/{id}/challenges/push/{channel}"}]},{"type":"group","label":"Fees","link":"/products/multi/openapi/fees","routeSlug":"/products/multi/openapi/fees","items":[{"label":"Charge fee to a corporate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/fees/corporatechargefee","routeSlug":"/products/multi/openapi/fees/corporatechargefee","metadata":{"seo":{"title":"Charge fee to a corporate","description":"Charge a fee to the corporate identified by the auth token, based on a pre-defined custom fee. Custom fees can be configured in the Multi Portal."}},"httpPath":"/corporates/fees/charge"},{"label":"(NEW) Get all fees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/fees/feesget","routeSlug":"/products/multi/openapi/fees/feesget","metadata":{"seo":{"title":"(NEW) Get all fees","description":"Returns the fee transactions accrued by the logged-in identity — every FeeTransaction posted against any of the identity's instruments, filterable by time window."}},"httpPath":"/fees"},{"label":"Charge fee to a consumer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/fees/consumerchargefee","routeSlug":"/products/multi/openapi/fees/consumerchargefee","metadata":{"seo":{"title":"Charge fee to a consumer","description":"Charge a fee to the logged-in consumer based on a pre-defined custom fee. Custom fees can be configured in the Multi Portal."}},"httpPath":"/consumers/fees/charge"}]},{"type":"separator","label":"Bulk Operations"},{"type":"group","label":"Operations","link":"/products/multi/openapi/operations","routeSlug":"/products/multi/openapi/operations","items":[{"label":"Create users in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/operations/bulksusercreate","routeSlug":"/products/multi/openapi/operations/bulksusercreate","metadata":{"seo":{"title":"Create users in bulk","description":"Submit the details for the creation of a batch of Authorised Users"}},"httpPath":"/bulks/users"},{"label":"Send user invites in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/operations/bulksuserinvitesend","routeSlug":"/products/multi/openapi/operations/bulksuserinvitesend","metadata":{"seo":{"title":"Send user invites in bulk","description":"Submit the details for the creation of a batch of Authorised User invites"}},"httpPath":"/bulks/users/_user_id_/invite"},{"label":"Block cards in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/operations/bulksmanagedcardblock","routeSlug":"/products/multi/openapi/operations/bulksmanagedcardblock","metadata":{"seo":{"title":"Block cards in bulk","description":"Submit the details to block Managed Cards."}},"httpPath":"/bulks/managed_cards/_id_/block"},{"label":"Unblock cards in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/operations/bulksmanagedcardunblock","routeSlug":"/products/multi/openapi/operations/bulksmanagedcardunblock","metadata":{"seo":{"title":"Unblock cards in bulk","description":"Submit the details to unblock Managed Cards."}},"httpPath":"/bulks/managed_cards/_id_/unblock"},{"label":"Remove cards in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/operations/bulksmanagedcardremove","routeSlug":"/products/multi/openapi/operations/bulksmanagedcardremove","metadata":{"seo":{"title":"Remove cards in bulk","description":"Submit the details to remove Managed Cards."}},"httpPath":"/bulks/managed_cards/_id_/remove"},{"label":"Update spend rules for a managed card in bulk","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/operations/bulksmanagedcardspendrulesupdate","routeSlug":"/products/multi/openapi/operations/bulksmanagedcardspendrulesupdate","metadata":{"seo":{"title":"Update spend rules for a managed card in bulk","description":"Submit the details to update the spend rules of Managed Cards"}},"httpPath":"/bulks/managed_cards/_id_/spend_rules"},{"label":"Create transfer transactions in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/operations/bulkstransfercreate","routeSlug":"/products/multi/openapi/operations/bulkstransfercreate","metadata":{"seo":{"title":"Create transfer transactions in bulk","description":"Submit the details for the creation of a batch of Transfers."}},"httpPath":"/bulks/transfers"},{"label":"Create send transactions in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/operations/bulkssendcreate","routeSlug":"/products/multi/openapi/operations/bulkssendcreate","metadata":{"seo":{"title":"Create send transactions in bulk","description":"Submit the details for the creation of a batch of Sends."}},"httpPath":"/bulks/sends"},{"label":"Create an outgoing wire transfer in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/operations/bulksoutgoingwiretransfercreate","routeSlug":"/products/multi/openapi/operations/bulksoutgoingwiretransfercreate","metadata":{"seo":{"title":"Create an outgoing wire transfer in bulk","description":"Submit the details for the creation of a batch of Outgoing Wire Transfers."}},"httpPath":"/bulks/outgoing_wire_transfers"}]},{"type":"group","label":"Manage","link":"/products/multi/openapi/manage","routeSlug":"/products/multi/openapi/manage","items":[{"label":"Get all bulk processes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/manage/bulks","routeSlug":"/products/multi/openapi/manage/bulks","metadata":{"seo":{"title":"Get all bulk processes","description":"Filter bulk processes."}},"httpPath":"/bulks"},{"label":"Get bulk process","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/manage/bulkid","routeSlug":"/products/multi/openapi/manage/bulkid","metadata":{"seo":{"title":"Get bulk process","description":"Retrieves details on the bulk process identified by the bulk_id parameter."}},"httpPath":"/bulks/{bulk_id}"},{"label":"Get all operations in a bulk","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/manage/bulkidoperations","routeSlug":"/products/multi/openapi/manage/bulkidoperations","metadata":{"seo":{"title":"Get all operations in a bulk","description":"Retrieves the bulk process operations that match the query parameters."}},"httpPath":"/bulks/{bulk_id}/operations"},{"label":"Execute bulk process","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/manage/bulkidexecute","routeSlug":"/products/multi/openapi/manage/bulkidexecute","metadata":{"seo":{"title":"Execute bulk process","description":"Launches execution of operations of any bulk process identified by the bulk_id  parameter."}},"httpPath":"/bulks/{bulk_id}/execute"},{"label":"Pause bulk process","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/manage/bulkidpause","routeSlug":"/products/multi/openapi/manage/bulkidpause","metadata":{"seo":{"title":"Pause bulk process","description":"Pauses the execution of operations of the bulk process that is in state ‘RUNNING’ as identified by the bulk_id  parameter."}},"httpPath":"/bulks/{bulk_id}/pause"},{"label":"Resume bulk process","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/manage/bulkidresume","routeSlug":"/products/multi/openapi/manage/bulkidresume","metadata":{"seo":{"title":"Resume bulk process","description":"Resumes the execution of operations of the bulk process that is in state ' PAUSED' as identified by the bulk_id parameter."}},"httpPath":"/bulks/{bulk_id}/resume"},{"label":"Cancel bulk process","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/manage/bulkidcancel","routeSlug":"/products/multi/openapi/manage/bulkidcancel","metadata":{"seo":{"title":"Cancel bulk process","description":"Cancels the execution of operations of a bulk process that is in state ‘PAUSED’ or ‘RUNNING’ as identified by the bulk_id parameter."}},"httpPath":"/bulks/{bulk_id}/cancel"}]}]}