Skip to main content

Multi API Version 2.9.0

· 5 min read
Adrian Mizzi

What's Changed​

  • We have made changes in an earlier release to remove the username for 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. and 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., and to use the email address instead. These fields are now marked as deprecated in the API:

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

  • Removal of deprecated field companyRegistrationTimestamp from Corporate Identity, and changing of other fields to optional (companyBusinessAddress, companyRegistrationAddress,companyRegistrationDate, rootTitle)

    • 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

  • Support for multiMulti Weavr Multi is an embedded finance solution that allows you to integrate financial services into your own application, providing a seamless experience for your customers. It enables you to offer managed accounts, managed cards, and transactions without requiring financial expertise.-tiered cardholder fees with the introduction of a feeGroup for Consumer and Corporate Identities

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

  • We now need to collect date of birth and address details for Consumer Identities. These details must be provided before starting 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. process. In an upcoming release, it will not be possible to start 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. if these details are not included.

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

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/{user_id}/get​
Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property username (string)
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​
Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property username (string)
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​
Request:​

Changed content type : application/json

  • Changed property username (string)

    The usernames used by the user to log in to the system

Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property username (string)
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 username (string)
Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property user (array)

      Changed items (object):

      • Changed property username (string)
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 optional properties:

    • companyBusinessAddress
    • companyRegistrationAddress
    • companyRegistrationDate
    • companyRegistrationTimestamp

    • Added property feeGroup (string)

      The fee group which the consumer is bound to.

    • Deleted property companyRegistrationTimestamp (integer)

      Deprecated field - use company_registration_date. Epoch timestamp using millisecond precision.

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 feeGroup (string)

    The fee group which the consumer will be bound to.

  • Deleted property companyRegistrationTimestamp (integer)

    Deprecated field - use company_registration_date. Epoch timestamp using millisecond precision.

Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    New optional properties:

    • companyBusinessAddress
    • companyRegistrationAddress
    • companyRegistrationDate
    • companyRegistrationTimestamp

    • Added property feeGroup (string)

      The fee group which the consumer is bound to.

    • Deleted property companyRegistrationTimestamp (integer)

      Deprecated field - use company_registration_date. Epoch timestamp using millisecond precision.

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:

  • companyBusinessAddress
  • companyRegistrationAddress
  • rootTitle

  • Added property feeGroup (string)

    The fee group which the consumer will be bound to.

  • Deleted property companyRegistrationTimestamp (integer)

    Deprecated field - use company_registration_date. Epoch timestamp using millisecond precision.

  • Changed property rootUsername (string)

    This is the username of the main user/owner for the corporate (the root userRoot user The individual who creates the identity. For corporate identities, the root user needs to be a legal representative of the corporate such as a director or a representative who has the power of attorney over the company. For consumer identities, the root user is the owner of the identity. Every identity must always have one root user.)

Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    New optional properties:

    • companyBusinessAddress
    • companyRegistrationAddress
    • companyRegistrationDate
    • companyRegistrationTimestamp

    • Added property feeGroup (string)

      The fee group which the consumer is bound to.

    • Deleted property companyRegistrationTimestamp (integer)

      Deprecated field - use company_registration_date. Epoch timestamp using millisecond precision.

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

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Added property dateOfBirth (object)

      • Property year (integer)

      • Property month (integer)

      • Property day (integer)

    • Added property address (object)

      • Property addressLine1 (string)

        Address of the consumer

      • Property addressLine2 (string)

        Continued address of the consumer

      • Property city (string)

        City of the consumer

      • Property country (string)

        Country of the consumer

      • Property postCode (string)

        Post code of the consumer

      • Property state (string)

        State of the consumer

    • Added property feeGroup (string)

      The fee group which the consumer is bound to.

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

  • Added property dateOfBirth (object)

    • Property year (integer)

    • Property month (integer)

    • Property day (integer)

  • Added property address (object)

    • Property addressLine1 (string)

      Address of the consumer

    • Property addressLine2 (string)

      Continued address of the consumer

    • Property city (string)

      City of the consumer

    • Property country (string)

      Country of the consumer

    • Property postCode (string)

      Post code of the consumer

    • Property state (string)

      State of the consumer

  • Added property feeGroup (string)

    The fee group which the consumer will be bound to.

Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Added property dateOfBirth (object)

      • Property year (integer)

      • Property month (integer)

      • Property day (integer)

    • Added property address (object)

      • Property addressLine1 (string)

        Address of the consumer

      • Property addressLine2 (string)

        Continued address of the consumer

      • Property city (string)

        City of the consumer

      • Property country (string)

        Country of the consumer

      • Property postCode (string)

        Post code of the consumer

      • Property state (string)

        State of the consumer

    • Added property feeGroup (string)

      The fee group which the consumer is bound to.

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

Changed content type : application/json

  • Added property dateOfBirth (object)

    • Property year (integer)

    • Property month (integer)

    • Property day (integer)

  • Added property address (object)

    • Property addressLine1 (string)

      Address of the consumer

    • Property addressLine2 (string)

      Continued address of the consumer

    • Property city (string)

      City of the consumer

    • Property country (string)

      Country of the consumer

    • Property postCode (string)

      Post code of the consumer

    • Property state (string)

      State of the consumer

  • Added property feeGroup (string)

    The fee group which the consumer will be bound to.

  • Changed property credentialCode (string)

    The username of the Consumer

Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Added property dateOfBirth (object)

      • Property year (integer)

      • Property month (integer)

      • Property day (integer)

    • Added property address (object)

      • Property addressLine1 (string)

        Address of the consumer

      • Property addressLine2 (string)

        Continued address of the consumer

      • Property city (string)

        City of the consumer

      • Property country (string)

        Country of the consumer

      • Property postCode (string)

        Post code of the consumer

      • Property state (string)

        State of the consumer

    • Added property feeGroup (string)

      The fee group which the consumer is bound to.