Skip to main content

Multi API Version 2.10.3

· 5 min read
Adrian Mizzi

What's Changed​

  • Previously deprecated API calls have now been removed

    • POST /auth/lost_password/start
    • POST /auth/lost_password/validate
    • POST /auth/lost_password/resume

  • Added validation on country code format (ISO 3166 alpha-2) and comments

  • Field sizes for some API calls have been shortened to be in line with our service providers

What's New​

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​

What's Deleted​

POST /auth/lost_password/validate​
POST /auth/lost_password/start​
POST /auth/lost_password/resume​

What's Deprecated​

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​

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}/invites/validate​
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

    • Changed property registrationCountry (string)

      The company's country of registration - using ISO 3166 alpha-2

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

    • Changed property registrationCountry (string)

      The company's country of registration - using ISO 3166 alpha-2

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

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

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property registrationCountry (string)

      The company's country of registration - using ISO 3166 alpha-2

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

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

    • Changed property address (object)

      Address of the consumer

      • Changed property country (string)

        Country of the identity - using ISO 3166 alpha-2

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

  • Changed property address (object)

    Address of the consumer

    • Changed property country (string)

      Country of the identity - using ISO 3166 alpha-2

Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property address (object)

      Address of the consumer

      • Changed property country (string)

        Country of the identity - using ISO 3166 alpha-2

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

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

  • Changed property address (object)

    Address of the consumer

    • Changed property country (string)

      Country of the identity - using ISO 3166 alpha-2

Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property address (object)

      Address of the consumer

      • Changed property country (string)

        Country of the identity - using ISO 3166 alpha-2

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • INVALID_COUNTRY
POST /managed_cards/get​
Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property card (array)

      Changed items (object):

      • Changed property billingAddress (object)

        The billing address set for the card holder required for AVS checking.

        • Changed property country (string)

          Country of the identity - using ISO 3166 alpha-2

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

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property billingAddress (object)

      The billing address set for the card holder required for AVS checking.

      • Changed property country (string)

        Country of the identity - using ISO 3166 alpha-2

POST /managed_cards/{id}/remove​
Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property billingAddress (object)

      The billing address set for the card holder required for AVS checking.

      • Changed property country (string)

        Country of the identity - using ISO 3166 alpha-2

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

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property billingAddress (object)

      The billing address set for the card holder required for AVS checking.

      • Changed property country (string)

        Country of the identity - using ISO 3166 alpha-2

POST /managed_cards/{id}/update​
Request:​

Changed content type : application/json

  • Changed property billingAddress (object)

    The billing address set for the card holder required for AVS checking.

    • Changed property country (string)

      Country of the identity - using ISO 3166 alpha-2

Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property billingAddress (object)

      The billing address set for the card holder required for AVS checking.

      • Changed property country (string)

        Country of the identity - using ISO 3166 alpha-2

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • INVALID_COUNTRY
POST /managedcards//create​
Request:​

Changed content type : application/json

  • Changed property billingAddress (object)

    The billing address set for the card holder required for AVS checking.

    • Changed property country (string)

      Country of the identity - using ISO 3166 alpha-2

Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property billingAddress (object)

      The billing address set for the card holder required for AVS checking.

      • Changed property country (string)

        Country of the identity - using ISO 3166 alpha-2

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • INVALID_COUNTRY
POST /managed_cards/{id}/freeze​
Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property billingAddress (object)

      The billing address set for the card holder required for AVS checking.

      • Changed property country (string)

        Country of the identity - using ISO 3166 alpha-2