Skip to main content

Multi API Version 2.3.0

· 5 min read
Adrian Mizzi

Fixes and Changes

  • Email Verification and Forgot Password base URL now correctly uses the URL configured in the Innovator Portal configuration screen.
  • Addition of email address in email verification URL
  • Removed count field in request and added responseCount in response
  • Changed field name from companyRegistrationTimestamp to companyRegistrationDate for Corporate

API Changes

Other minor changes in some APIs.

  • Changed field companyRegistrationTimestamp to companyRegistrationDate in

    • 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
    • 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
    • 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
  • Removed count parameter in get requests, and added responseCount in response:

    • 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
    • POST /managed_accounts/get
    • POST /managed_accounts/{id}/statement/get
    • POST /managed_cards/get
    • POST /managed_cards/{id}/statement/get
    • 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
    • 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
  • Addition of new error code INSTRUMENT_NOT_FOUND in

    • POST /managed_accounts/{id}/freeze
    • POST /managed_accounts/{id}/unfreeze
    • POST /managed_accounts/{id}/update
    • POST /managed_accounts/{id}/destroy
    • POST /managedaccounts//create
    • POST /managed_cards/{id}/freeze
    • POST /managed_cards/{id}/unfreeze
    • POST /managed_cards/{id}/update
    • POST /managed_cards/{id}/destroy

Detailed Changes

What's Changed

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
Request:

Changed content type : application/json

  • Changed property paging (object)

    • Deleted property count (boolean)
Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Added property responseCount (integer)

      Count of entries with page filtering.

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
Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    New required properties:

    • companyRegistrationDate
    • Added property companyRegistrationDate (integer)

      The company's registration date

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
Request:

Changed content type : application/json

  • Added property companyRegistrationDate (integer)

    The registration date of the company - using epoch time

Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    New required properties:

    • companyRegistrationDate
    • Added property companyRegistrationDate (integer)

      The company's registration date

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
Request:

Changed content type : application/json

New optional properties:

  • companyRegistrationTimestamp
  • Added property companyRegistrationDate (integer)

    The registration date of the company - using epoch time

  • Changed property companyRegistrationTimestamp (integer)

    Deprecated

Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    New required properties:

    • companyRegistrationDate
    • Added property companyRegistrationDate (integer)

      The company's registration date

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
Return Type:

New response : 409 Conflict

Conflict

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
Request:

Changed content type : application/json

  • Deleted property tag (string)
Return Type:

New response : 409 Conflict

Conflict

POST /managed_accounts/get
Request:

Changed content type : application/json

  • Changed property paging (object)

    • Deleted property count (boolean)
Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Added property responseCount (integer)

      Count of entries with page filtering.

POST /managed_accounts/{id}/unfreeze
Return Type:

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • INSTRUMENT_NOT_FOUND
POST /managed_accounts/{id}/statement/get
Request:

Changed content type : application/json

  • Changed property paging (object)

    • Deleted property count (boolean)
Return Type:

New response : 409 Conflict

Conflict Changed response : 200 OK Success

  • Changed content type : application/json

    • Added property responseCount (integer)

      Count of entries with page filtering.

POST /managed_accounts/{id}/get
Return Type:

New response : 409 Conflict

Conflict

POST /managed_accounts/{id}/update
Return Type:

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • INSTRUMENT_NOT_FOUND
POST /managed_accounts/{id}/destroy
Return Type:

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • INSTRUMENT_NOT_FOUND
POST /managedaccounts//create
Return Type:

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • INSTRUMENT_NOT_FOUND
POST /managed_accounts/{id}/freeze
Return Type:

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • INSTRUMENT_NOT_FOUND
POST /managed_cards/get
Request:

Changed content type : application/json

  • Changed property paging (object)

    • Deleted property count (boolean)
Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Added property responseCount (integer)

      Count of entries with page filtering.

POST /managed_cards/{id}/unfreeze
Return Type:

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • INSTRUMENT_NOT_FOUND
POST /managed_cards/{id}/statement/get
Request:

Changed content type : application/json

  • Changed property paging (object)

    • Deleted property count (boolean)
Return Type:

New response : 409 Conflict

Conflict Changed response : 200 OK Success

  • Changed content type : application/json

    • Added property responseCount (integer)

      Count of entries with page filtering.

POST /managed_cards/{id}/get
Return Type:

New response : 409 Conflict

Conflict

POST /managed_cards/{id}/update
Return Type:

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • INSTRUMENT_NOT_FOUND
POST /managed_cards/{id}/destroy
Return Type:

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • INSTRUMENT_NOT_FOUND
POST /managedcards//create
Return Type:

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • INSTRUMENT_NOT_FOUND
POST /managed_cards/{id}/freeze
Return Type:

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • INSTRUMENT_NOT_FOUND
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
Request:

Changed content type : application/json

  • Changed property paging (object)

    • Deleted property count (boolean)
Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Added property responseCount (integer)

      Count of entries with page filtering.

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
Request:

Changed content type : application/json

  • Changed property paging (object)

    • Deleted property count (boolean)
Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Added property responseCount (integer)

      Count of entries with page filtering.