Skip to main content

Multi API Version 2.11.8

· 3 min read
Maria Stellini

What's New

  • The kyc object returned as part of the following API calls has been deprecated and instead a new API call /consumers/\{id\}/kyc/get has been added added to return 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. specific information

    • 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
  • The kyb object returned as part of the following API calls has been deprecated and instead a new API call /corporates/\{id\}/kyb/get has been added to return 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. specific information

    • 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

What's Changed

  • The property basicCompanyChecksVerified has been deprecated from the kyb object. This information is already being provided in the fullCompanyChecksVerified property

    • 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 /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./get
  • The properties pep, sanctioned and enhancedDueDiligence has been deprecated from the kyb 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}/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
    • 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./get
  • A new property credentialId will be returned in case of a conflict response

    • POST /auth/login_with_password`
  • A new property nationality has been added.

    • 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 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}/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./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}/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./get

What's Changed

POST /auth/login_with_password
Return Type:

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Added property credentialId (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

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

      • Changed property basicCompanyChecksVerified (string)

        The status of the Basic Company Verification Checks for the corporate entity.

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

      • Changed property basicCompanyChecksVerified (string)

        The status of the Basic Company Verification Checks for the corporate entity.

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

      • Changed property basicCompanyChecksVerified (string)

        The status of the Basic Company Verification Checks for the corporate entity.

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

      Nationality of the consumer - using ISO 3166 alpha-2

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

      • Changed property pep (string)

        The status of the PEP Check for the consumer.

      • Changed property sanctioned (string)

        The status of the Sanctions Check for the consumer.

      • Changed property enhancedDueDiligence (string)

        The status of the Enhanced Due Diligence Check for the consumer.

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

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Added property nationality (string)

      Nationality of the consumer - using ISO 3166 alpha-2

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

      • Changed property pep (string)

        The status of the PEP Check for the consumer.

      • Changed property sanctioned (string)

        The status of the Sanctions Check for the consumer.

      • Changed property enhancedDueDiligence (string)

        The status of the Enhanced Due Diligence Check for the consumer.

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

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Added property nationality (string)

      Nationality of the consumer - using ISO 3166 alpha-2

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

      • Changed property pep (string)

        The status of the PEP Check for the consumer.

      • Changed property sanctioned (string)

        The status of the Sanctions Check for the consumer.

      • Changed property enhancedDueDiligence (string)

        The status of the Enhanced Due Diligence Check for the consumer.