Multi API Version 2.13.24
Additional validation for the call-ref parameter
When calling any of the APIs offered by Weavr, you can optionally specify a value for the call-ref parameter. If we receive 2 API requests with the same call-ref value, the request will only be executed once. This avoids executing requests multiple times by mistake.
The call-ref parameter has been restricted to a maximum of 255 characters. If a longer call-ref is provided an error 400 - Bad Request will be returned.
API ChangeLog
What's Changed
POST /auth/invites/{invite_id}/consume
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /auth/login_with_password
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /auth/logout
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /passwords/lost_password/validate
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /passwords/lost_password/start
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /passwords/lost_password/resume
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /passwords/identities/{identity_id}/create
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /passwords/validate
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /passwords/{credential_id}/{version}/expire
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /passwords/{credential_id}/update
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /passwords/{credential_id}/create
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /passwords/{credential_id}/expire
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{id}/get
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{id}/update
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./_/create
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{id}/kybKYB Know Your Business - the identity verification process for corporate identities. This process allows you to seamlessly and securely verify your business customer's identity. Weavr will ask users to submit the necessary information and documentation so that they can get approved by financial providers./get
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{id}/kybKYB Know Your Business - the identity verification process for corporate identities. This process allows you to seamlessly and securely verify your business customer's identity. Weavr will ask users to submit the necessary information and documentation so that they can get approved by financial providers./start
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{id}/invites/validate
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{id}/invites/{invite_id}/validate
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{id}/invites/{invite_id}/sendSend A transaction type that allows sending funds to another identity's instrument or to a beneficiary. Send transactions may require Strong Customer Authentication depending on the destination and whether it's a trusted beneficiary.
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{id}/charge_fee
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{id}/users/get
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{id}/users/mobile/verify
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{id}/users/mobile/send_verification_code
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{id}/users/{user_id}/get
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{id}/users/{user_id}/update
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{id}/users/_/create
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{id}/users/{user_id}/invites/validate
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{id}/users/{user_id}/invites/sendSend A transaction type that allows sending funds to another identity's instrument or to a beneficiary. Send transactions may require Strong Customer Authentication depending on the destination and whether it's a trusted beneficiary.
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{id}/users/{user_id}/deactivate
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{id}/users/{user_id}/activate
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{id}/users/email/verify
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /corporatesCorporates Business entities that can be onboarded as identities on Weavr. Corporate identities represent companies and require Know Your Business (KYB) verification. They can have multiple authorised users and issue cards to card assignees./{id}/users/email/send_verification_code
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /consumersConsumers Individual persons who can be onboarded as identities on Weavr. Consumer identities represent individual customers and require Know Your Customer (KYC) verification. For consumers, the card owner and card assignee are typically the same person./{id}/get
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /consumersConsumers Individual persons who can be onboarded as identities on Weavr. Consumer identities represent individual customers and require Know Your Customer (KYC) verification. For consumers, the card owner and card assignee are typically the same person./{id}/update
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /consumersConsumers Individual persons who can be onboarded as identities on Weavr. Consumer identities represent individual customers and require Know Your Customer (KYC) verification. For consumers, the card owner and card assignee are typically the same person./_/create
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /consumersConsumers Individual persons who can be onboarded as identities on Weavr. Consumer identities represent individual customers and require Know Your Customer (KYC) verification. For consumers, the card owner and card assignee are typically the same person./{id}/kycKYC Know Your Customer - the identity verification process for consumer identities. This process allows you to seamlessly and securely verify your user's identity. Weavr will ask users to submit the necessary information and documentation so that they can get approved by financial providers./get
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /consumersConsumers Individual persons who can be onboarded as identities on Weavr. Consumer identities represent individual customers and require Know Your Customer (KYC) verification. For consumers, the card owner and card assignee are typically the same person./{id}/kycKYC Know Your Customer - the identity verification process for consumer identities. This process allows you to seamlessly and securely verify your user's identity. Weavr will ask users to submit the necessary information and documentation so that they can get approved by financial providers./start
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /consumersConsumers Individual persons who can be onboarded as identities on Weavr. Consumer identities represent individual customers and require Know Your Customer (KYC) verification. For consumers, the card owner and card assignee are typically the same person./{id}/charge_fee
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /consumersConsumers Individual persons who can be onboarded as identities on Weavr. Consumer identities represent individual customers and require Know Your Customer (KYC) verification. For consumers, the card owner and card assignee are typically the same person./{id}/mobile/verify
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /consumersConsumers Individual persons who can be onboarded as identities on Weavr. Consumer identities represent individual customers and require Know Your Customer (KYC) verification. For consumers, the card owner and card assignee are typically the same person./{id}/mobile/send_verification_code
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /consumersConsumers Individual persons who can be onboarded as identities on Weavr. Consumer identities represent individual customers and require Know Your Customer (KYC) verification. For consumers, the card owner and card assignee are typically the same person./{id}/email/verify
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /consumersConsumers Individual persons who can be onboarded as identities on Weavr. Consumer identities represent individual customers and require Know Your Customer (KYC) verification. For consumers, the card owner and card assignee are typically the same person./{id}/email/send_verification_code
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /managed_accounts/get
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /managed_accounts/{id}/remove
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /managed_accounts/{id}/get
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /managed_accounts/{id}/update
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /managedaccounts//create
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /managed_accounts/{id}/freeze
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /managed_accounts/{id}/unfreeze
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /managed_accounts/{id}/statement/get
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /managed_cards/get
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /managed_cards/{id}/remove
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /managed_cards/{id}/get
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /managed_cards/{id}/update
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /managedcards//create
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /managed_cards/{id}/freeze
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /managed_cards/{id}/unfreeze
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /managed_cards/{id}/physical/report_stolen
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /managed_cards/{id}/physical/replace_damaged
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /managed_cards/{id}/physical/report_lost
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /managed_cards/{id}/physical/replace_lost_stolen
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /managed_cards/{id}/physical/activate
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /managed_cards/{id}/physical/upgrade
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /managed_cards/{id}/physical/pin/get
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /managed_cards/{id}/physical/pin/set
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /managed_cards/{id}/physical/pin/unblock
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /managed_cards/{id}/auth_rule/get
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /managed_cards/{id}/auth_rule/set
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /managedcards//assign
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /managed_cards/{id}/statement/get
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /transfersTransfer A transaction that moves funds between instruments managed by Weavr. The source and destination instruments of a transfer transaction must be owned by the same identity. Transfers can be scheduled for future execution and can be performed in bulk operations./get
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /transfersTransfer A transaction that moves funds between instruments managed by Weavr. The source and destination instruments of a transfer transaction must be owned by the same identity. Transfers can be scheduled for future execution and can be performed in bulk operations./{id}/get
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /transfersTransfer A transaction that moves funds between instruments managed by Weavr. The source and destination instruments of a transfer transaction must be owned by the same identity. Transfers can be scheduled for future execution and can be performed in bulk operations./_/execute
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /sendSend A transaction type that allows sending funds to another identity's instrument or to a beneficiary. Send transactions may require Strong Customer Authentication depending on the destination and whether it's a trusted beneficiary./get
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /sendSend A transaction type that allows sending funds to another identity's instrument or to a beneficiary. Send transactions may require Strong Customer Authentication depending on the destination and whether it's a trusted beneficiary./{id}/get
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /sendSend A transaction type that allows sending funds to another identity's instrument or to a beneficiary. Send transactions may require Strong Customer Authentication depending on the destination and whether it's a trusted beneficiary./_/execute
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /outgoing_wire_transfersTransfer A transaction that moves funds between instruments managed by Weavr. The source and destination instruments of a transfer transaction must be owned by the same identity. Transfers can be scheduled for future execution and can be performed in bulk operations./get
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /outgoing_wire_transfersTransfer A transaction that moves funds between instruments managed by Weavr. The source and destination instruments of a transfer transaction must be owned by the same identity. Transfers can be scheduled for future execution and can be performed in bulk operations./{id}/get
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255
POST /outgoingwire_transfersTransfer A transaction that moves funds between instruments managed by Weavr. The source and destination instruments of a transfer transaction must be owned by the same identity. Transfers can be scheduled for future execution and can be performed in bulk operations.//execute
Parameters:
Changed: call-ref in header
A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255