Skip to main content

Multi API Version 2.5.1

· 5 min read
Adrian Mizzi

What's Changed​

  • Change in field name defaultCurrency to baseCurrency in Corporate and Consumer Identities
  • Changed allowedLimit to remainingLimit type to Currency Amount. Currency is the same as baseCurrency
  • Added enhancedCompanyChecksVerified to Corporate Identity
  • Added enhancedDueDiligence to Consumer Identity
  • Reverted a change in a previous release and re-introduced mandatory email and mobile number to Consumer Identity

Detailed Changes​

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

    • Added property baseCurrency (string)

      The default currency of the corporate

    • Deleted property defaultCurrency (string)

      The default currency of the corporate

    • Changed property kyb (object)

      The 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. status of the corporate account.

      • Added property enhancedCompanyChecksVerified (object)

        Enum values:

        • "NOT_STARTED"
        • "INITIATED"
        • "APPROVED"
        • "REJECTED"

      • Changed property allowedLimit (integer -> object)

        The allowed funding limit for the corporate given the current 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. Status.

      • Changed property remainingLimit (integer -> object)

        The remaining funding limit for the corporate given the current 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. Status. This is the difference between the allowedLimit amount and the total number of funding balance movements.

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

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Added property baseCurrency (string)

      The default currency of the corporate

    • Deleted property defaultCurrency (string)

      The default currency of the corporate

    • Changed property kyb (object)

      The 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. status of the corporate account.

      • Added property enhancedCompanyChecksVerified (object)

        Enum values:

        • "NOT_STARTED"
        • "INITIATED"
        • "APPROVED"
        • "REJECTED"

      • Changed property allowedLimit (integer -> object)

        The allowed funding limit for the corporate given the current 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. Status.

      • Changed property remainingLimit (integer -> object)

        The remaining funding limit for the corporate given the current 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. Status. This is the difference between the allowedLimit amount and the total number of funding balance movements.

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

  • Added property baseCurrency (string)

    The default currency of the corporate

  • Deleted property defaultCurrency (string)

    The default currency of the corporate

Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Added property baseCurrency (string)

      The default currency of the corporate

    • Deleted property defaultCurrency (string)

      The default currency of the corporate

    • Changed property kyb (object)

      The 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. status of the corporate account.

      • Added property enhancedCompanyChecksVerified (object)

        Enum values:

        • "NOT_STARTED"
        • "INITIATED"
        • "APPROVED"
        • "REJECTED"

      • Changed property allowedLimit (integer -> object)

        The allowed funding limit for the corporate given the current 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. Status.

      • Changed property remainingLimit (integer -> object)

        The remaining funding limit for the corporate given the current 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. Status. This is the difference between the allowedLimit amount and the total number of funding balance movements.

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

    New required properties:

    • email
    • mobileCountryCode
    • mobileNumber

    • Added property baseCurrency (string)

      The default currency of the consumer

    • Deleted property defaultCurrency (string)

      The default currency of the consumer

    • Changed property kyc (object)

      The 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. status of the consumer.

      • Added property enhancedDueDiligence (object)

        Enum values:

        • "NOT_STARTED"
        • "INITIATED"
        • "APPROVED"
        • "REJECTED"

      • Changed property allowedLimit (integer -> object)

        The allowed funding limit for the consumer given the current 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. Status.

      • Changed property remainingLimit (integer -> object)

        The remaining funding limit for the consumer given the current 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. Status. This is the difference between the allowedLimit amount and the total number of funding balance movements.

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

    The email address of the Consumer

  • Added property mobileCountryCode (string)

    The country code of the Consumer's mobile number (e.g. +44)

  • Added property mobileNumber (string)

    The mobile number of the Consumer - excluding country code

Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    New required properties:

    • email
    • mobileCountryCode
    • mobileNumber

    • Added property baseCurrency (string)

      The default currency of the consumer

    • Deleted property defaultCurrency (string)

      The default currency of the consumer

    • Changed property kyc (object)

      The 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. status of the consumer.

      • Added property enhancedDueDiligence (object)

        Enum values:

        • "NOT_STARTED"
        • "INITIATED"
        • "APPROVED"
        • "REJECTED"

      • Changed property allowedLimit (integer -> object)

        The allowed funding limit for the consumer given the current 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. Status.

      • Changed property remainingLimit (integer -> object)

        The remaining funding limit for the consumer given the current 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. Status. This is the difference between the allowedLimit amount and the total number of funding balance movements.

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

New required properties:

  • email
  • mobileCountryCode
  • mobileNumber

  • Added property baseCurrency (string)

    The default currency of the consumer

  • Deleted property defaultCurrency (string)

    The default currency of the consumer

Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    New required properties:

    • email
    • mobileCountryCode
    • mobileNumber

    • Added property baseCurrency (string)

      The default currency of the consumer

    • Deleted property defaultCurrency (string)

      The default currency of the consumer

    • Changed property kyc (object)

      The 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. status of the consumer.

      • Added property enhancedDueDiligence (object)

        Enum values:

        • "NOT_STARTED"
        • "INITIATED"
        • "APPROVED"
        • "REJECTED"

      • Changed property allowedLimit (integer -> object)

        The allowed funding limit for the consumer given the current 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. Status.

      • Changed property remainingLimit (integer -> object)

        The remaining funding limit for the consumer given the current 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. Status. This is the difference between the allowedLimit amount and the total number of funding balance movements.

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

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Removed enum value:

      • "EMAIL_NOT_UNIQUE"
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​
Return Type:​

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Removed enum values:

      • "PROFILE_NOT_FOUND"
      • "EMAIL_NOT_UNIQUE"