Skip to main content

Multi API Version 2.4.4

· 2 min read
Adrian Mizzi

What's Changed

  • Changes to Consumer APIs - email address and mobile number are only updated after verification is successful. This ensures that a validated email address (or mobile number) is not replaced with an invalid one.

    • Removal of email address and mobile number parameters from /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 email address and mobile number parameters from /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
    • Email and mobile number parameters are now optional in response of /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
  • Changes to Consumer APIs - name and surname cannot be updated if the Consumer Identity is already verified.

    • New error code CONSUMER_VERIFIED with /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

What's Changed

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

    • email
    • mobileCountryCode
    • mobileNumber
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

  • Deleted property email (string)

    The email address of the Consumer

  • Deleted property mobileCountryCode (string)

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

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

    • email
    • mobileCountryCode
    • mobileNumber

Changed response : 409 Conflict

Conflict

  • Changed content type : application/json

    • Changed property errorCode (string)

      Added enum value:

      • "CONSUMER_VERIFIED"
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:

  • email
  • mobileCountryCode
  • mobileNumber
  • Deleted property email (string)

    The email address of the Consumer

  • Deleted property mobileCountryCode (string)

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

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

    • email
    • mobileCountryCode
    • mobileNumber

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)

      Added enum values:

      • "PROFILE_NOT_FOUND"
      • "EMAIL_NOT_UNIQUE"