Skip to main content

Version 2.9.0

· 6 min read

What's Changed​

  • We have made changes in an earlier release to remove the username for Consumers and Corporates, and to use the email address instead. These fields are now marked as deprecated in the API:

    • POST /corporates/{id}/users/{user_id}/get
    • POST /corporates/{id}/users/{user_id}/update
    • POST /corporates/{id}/users/_/create
    • POST /corporates/{id}/users/get
    • POST /corporates/_/create
    • POST /consumers/_/create

  • Removal of deprecated field companyRegistrationTimestamp from Corporate Identity, and changing of other fields to optional (companyBusinessAddress, companyRegistrationAddress,companyRegistrationDate, rootTitle)

    • POST /corporates/{id}/get
    • POST /corporates/{id}/update
    • POST /corporates/_/create

  • Support for multi-tiered cardholder fees with the introduction of a feeGroup for Consumer and Corporate Identities

    • POST /corporates/{id}/get
    • POST /corporates/{id}/update
    • POST /corporates/_/create
    • POST /consumers/{id}/get
    • POST /consumers/{id}/update
    • POST /consumers/_/create

  • We now need to collect date of birth and address details for Consumer Identities. These details must be provided before starting KYC process. In an upcoming release, it will not be possible to start KYC if these details are not included.

    • POST /consumers/{id}/get
    • POST /consumers/{id}/update
    • POST /consumers/_/create

What's Changed​

POST /corporates/{id}/users/{user_id}/get​
Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property username (string)
POST /corporates/{id}/users/{user_id}/update​
Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property username (string)
POST /corporates/{id}/users/_/create​
Request:​

Changed content type : application/json

  • Changed property username (string)

    The usernames used by the user to log in to the system

Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property username (string)
POST /corporates/{id}/users/get​
Request:​

Changed content type : application/json

  • Changed property username (string)
Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property user (array)

      Changed items (object):

      • Changed property username (string)
POST /corporates/{id}/get​
Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    New optional properties:

    • companyBusinessAddress

    • companyRegistrationAddress

    • companyRegistrationDate

    • companyRegistrationTimestamp

    • Added property feeGroup (string)

      The fee group which the consumer is bound to.

    • Deleted property companyRegistrationTimestamp (integer)

      Deprecated field - please use company_registration_date. Epoch timestamp using millisecond precision.

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

Changed content type : application/json

  • Added property feeGroup (string)

    The fee group which the consumer will be bound to.

  • Deleted property companyRegistrationTimestamp (integer)

    Deprecated field - please use company_registration_date. Epoch timestamp using millisecond precision.

Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    New optional properties:

    • companyBusinessAddress

    • companyRegistrationAddress

    • companyRegistrationDate

    • companyRegistrationTimestamp

    • Added property feeGroup (string)

      The fee group which the consumer is bound to.

    • Deleted property companyRegistrationTimestamp (integer)

      Deprecated field - please use company_registration_date. Epoch timestamp using millisecond precision.

POST /corporates/_/create​
Request:​

Changed content type : application/json

New optional properties:

  • companyBusinessAddress
  • companyRegistrationAddress
  • rootTitle

  • Added property feeGroup (string)

    The fee group which the consumer will be bound to.

  • Deleted property companyRegistrationTimestamp (integer)

    Deprecated field - please use company_registration_date. Epoch timestamp using millisecond precision.

  • Changed property rootUsername (string)

    This is the username of the main user/owner for the corporate (the root user)

Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    New optional properties:

    • companyBusinessAddress

    • companyRegistrationAddress

    • companyRegistrationDate

    • companyRegistrationTimestamp

    • Added property feeGroup (string)

      The fee group which the consumer is bound to.

    • Deleted property companyRegistrationTimestamp (integer)

      Deprecated field - please use company_registration_date. Epoch timestamp using millisecond precision.

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

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Added property dateOfBirth (object)

      • Property year (integer)

      • Property month (integer)

      • Property day (integer)

    • Added property address (object)

      • Property addressLine1 (string)

        Address of the consumer

      • Property addressLine2 (string)

        Continued address of the consumer

      • Property city (string)

        City of the consumer

      • Property country (string)

        Country of the consumer

      • Property postCode (string)

        Post code of the consumer

      • Property state (string)

        State of the consumer

    • Added property feeGroup (string)

      The fee group which the consumer is bound to.

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

Changed content type : application/json

  • Added property dateOfBirth (object)

    • Property year (integer)

    • Property month (integer)

    • Property day (integer)

  • Added property address (object)

    • Property addressLine1 (string)

      Address of the consumer

    • Property addressLine2 (string)

      Continued address of the consumer

    • Property city (string)

      City of the consumer

    • Property country (string)

      Country of the consumer

    • Property postCode (string)

      Post code of the consumer

    • Property state (string)

      State of the consumer

  • Added property feeGroup (string)

    The fee group which the consumer will be bound to.

Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Added property dateOfBirth (object)

      • Property year (integer)

      • Property month (integer)

      • Property day (integer)

    • Added property address (object)

      • Property addressLine1 (string)

        Address of the consumer

      • Property addressLine2 (string)

        Continued address of the consumer

      • Property city (string)

        City of the consumer

      • Property country (string)

        Country of the consumer

      • Property postCode (string)

        Post code of the consumer

      • Property state (string)

        State of the consumer

    • Added property feeGroup (string)

      The fee group which the consumer is bound to.

POST /consumers/_/create​
Request:​

Changed content type : application/json

  • Added property dateOfBirth (object)

    • Property year (integer)

    • Property month (integer)

    • Property day (integer)

  • Added property address (object)

    • Property addressLine1 (string)

      Address of the consumer

    • Property addressLine2 (string)

      Continued address of the consumer

    • Property city (string)

      City of the consumer

    • Property country (string)

      Country of the consumer

    • Property postCode (string)

      Post code of the consumer

    • Property state (string)

      State of the consumer

  • Added property feeGroup (string)

    The fee group which the consumer will be bound to.

  • Changed property credentialCode (string)

    The username of the Consumer

Return Type:​

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Added property dateOfBirth (object)

      • Property year (integer)

      • Property month (integer)

      • Property day (integer)

    • Added property address (object)

      • Property addressLine1 (string)

        Address of the consumer

      • Property addressLine2 (string)

        Continued address of the consumer

      • Property city (string)

        City of the consumer

      • Property country (string)

        Country of the consumer

      • Property postCode (string)

        Post code of the consumer

      • Property state (string)

        State of the consumer

    • Added property feeGroup (string)

      The fee group which the consumer is bound to.