Skip to main content

Multi API Version 2.7.0

· 3 min read
Adrian Mizzi

What's New​

  • As part of charging capability (innovator charges to cardholder) we are introducing custom fees

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

  • Introduction of kyb/start for starting Corporate 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. process

    • 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

  • Introduction of withdrawal capability from managed_accounts

    • POST /managed_accounts/withdraw/get
    • POST /managed_accounts/{id}/withdraw/{withdraw_id}/get
    • POST /managedaccounts/{id}/withdraw//create
    • POST /managed_accounts/{id}/withdraw/get

What's Changed​

  • Previously deprecated destroy have now been removed

    • POST /managed_accounts/{id}/destroy
    • POST /managed_cards/{id}/destroy

  • Lost password end points have moved from auth to passwords. auth is still available, but deprecated

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

  • New error code returned in case 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. is attempted for a Consumer who is already approved

    • 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

  • Removal of secretType from APIs

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

What's New​

POST /passwords/lost_password/validate​
POST /passwords/lost_password/start​
POST /passwords/lost_password/resume​
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​
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​
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​
POST /managed_accounts/withdraw/get​
POST /managed_accounts/{id}/withdraw/{withdraw_id}/get​
POST /managedaccounts/{id}/withdraw//create​
POST /managed_accounts/{id}/withdraw/get​

What's Deleted​

POST /managed_accounts/{id}/destroy​
POST /managed_cards/{id}/destroy​

What's Deprecated​

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

What's Changed​

POST /auth/lost_password/validate​
Request:​

Changed content type : application/json

  • Changed property email (string)

  • Changed property nonce (string)

Return Type:​

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • INVALID_NONCE_OR_EMAIL

      Removed enum values:

      • PASSWORD_ALREADY_USED
      • PASSWORD_TOO_SHORT
      • PASSWORD_TOO_LONG
      • PASSWORD_TOO_SIMPLE
      • PASSWORD_INCORRECT
POST /auth/lost_password/start​
Request:​

Changed content type : application/json

  • Changed property email (string)
POST /auth/lost_password/resume​
Request:​

Changed content type : application/json

  • Changed property email (string)

  • Changed property nonce (string)

Return Type:​

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

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

    New optional properties:

    • secretType
    • Deleted property secretType (object)
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​
Request:​

Changed content type : application/json

  • Deleted property secretType (object)

    Determines what authentication methods should be used. In general, this should have firstSecretType set to passwords. In the future will allow for secondary authentication mechanisms.

Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    New optional properties:

    • secretType
    • Deleted property secretType (object)
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

New optional properties:

  • secretType
  • Deleted property secretType (object)
Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    New optional properties:

    • secretType
    • Deleted property secretType (object)
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​
Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property user (array)

      Changed items (object):

      New optional properties:

      • secretType
      • Deleted property secretType (object)
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:

  • rootSecretType
  • Deleted property rootSecretType (object)
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​
Return Type:​

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • KYC_ALREADY_APPROVED
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 optional properties:

  • secretType
  • Deleted property secretType (object)