Developer Docs
Hubex
Technical Changelog
Version 1.1.71

API Docs Version 1.1.71

What's New

POST /e-sign

Sends mail to recipients with the documents

GET /e-sign/consent

Gets the consent url

GET /e-sign/status/{signature_id}

Retrieves the status of the specified envelope

What's Deleted

POST /quick-sign

Sends mail to recipients with the documents

GET /quick-sign/consent

Gets the consent url

GET /quick-sign/status/{signature_id}

Retrieves the status of the specified envelope

GET /health

Health

GET /version

Version

What's Changed

GET /api-version

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

POST /void-contract

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

POST /payment/account-links

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

DELETE /payment/products/{product_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

POST /payment/invoices/search-by-metadata

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

GET /payment/invoice/credit-notes

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

POST /fraud-identification/email-auth-score

Request:

Changed content type : application/json

  • Changed property email (string)

    The user’s email address. Must conform to RFC 5322 format and contain a valid top-level domain. (e.g. johndoe@example.com)

POST /credit/check

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property transunion (object)

      • Property addresses (object)

        List of address against the user

      • Property consumer (object)

        Consumer Information

        • Property first_name (string)

          Consumer First Name

        • Property middle_name (string)

          Conumer Middle Name

        • Property last_name (string)

          Consumer Last Name

        • Property date_of_birth (string)

          Consumer Date of Birth

      • Property phones (object)

        Consumer Contact Phone Numbers

      • Property social_security_number (string)

        Consumer Social Security Number

      • Property trade (array)

        Credit Trade Information

        Items (object):

        • Property account_number (string)

        • Property activity_open_closed (string)

          Either Activity is closed or open

        • Property customer_number (string)

          Customer Trade Number

        • Property account_type (string)

          Customer Account Type

        • Property months_reviewed (integer)

        • Property customer_name (string)

        • Property date_reported (string)

        • Property date_opened (string)

        • Property last_payment_date (string)

        • Property amount1 (string)

        • Property amount2 (string)

        • Property terms (string)

        • Property balance_date (string)

        • Property payment_data (object)

          • Property compliance_condition (string)

          • Property credit_limit_amount (string)

          • Property enhanced_account_condition (string)

          • Property enhanced_account_type (string)

          • Property enhanced_payment_history (string)

          • Property enhanced_payment_status (string)

          • Property enhanced_special_comment (string)

          • Property enhanced_terms (string)

          • Property enhanced_terms_frequency (string)

          • Property high_balance_amount (string)

          • Property payment_level_date (string)

      • Property risk_model (object)

        • Property score (integer)

        • Property score_factor (array)

          Items (object):

          • Property code (integer)

        • Property model_indicator (string)

        • Property evaluation (string)

        • Property score_number_marketing_industry (string)

    • Added property experian (object)

    • Added property equifax (object)

    • Deleted property success (boolean)

      Flag to indicate operation is successful

GET /payment/invoices/{invoice_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property payment_settings (object)

      • Changed property payment_method_types (string -> object)

PATCH /payment/invoices/{invoice_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property payment_settings (object)

      • Changed property payment_method_types (string -> object)

POST /payment/invoices/{invoice_id}/send

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property payment_settings (object)

      • Changed property payment_method_types (string -> object)

POST /payment/invoices/{invoice_id}/void

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property payment_settings (object)

      • Changed property payment_method_types (string -> object)

POST /payment/invoices

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property payment_settings (object)

      • Changed property payment_method_types (string -> object)

GET /payment/invoices

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property data (array)

      Changed items (object):

      • Changed property payment_settings (object)

        • Changed property payment_method_types (string -> object)

GET /payment/invoices/search

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property data (array)

      Changed items (object):

      • Changed property payment_settings (object)

        • Changed property payment_method_types (string -> object)

GET /payment/invoices/search-by-query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property data (array)

      Changed items (object):

      • Changed property payment_settings (object)

        • Changed property payment_method_types (string -> object)

DELETE /configuration

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

GET /configuration

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property e_sign (object)

      Configuration for E-signature

      • Property docusign (object)

        Docusign Configuration

        • Property oauth_hostname (string)

          API hostname for envelopes

        • Property api_base_url (string)

          Docusign API base URL

        • Property api_version (string)

          Docusign API version

        • Property user_id (string)

          Docusign User ID

        • Property account_id (string)

          Docusign Account ID

        • Property client_id (string)

          Docusign Client ID

        • Property webhook_url (string)

          Your webhook URL for where you want the response

        • Property jwt_oauth_hostname (string)

          Docusign JWT OAUTH hostname

        • Property secret_key (string)

          Docusign RSA Private Key in base64 encoding

    • Deleted property quick_sign (object)

      Configuration for E-signature

POST /configuration

Request:

Changed content type : application/json

  • Added property e_sign (object)

  • Deleted property quick_sign (object)

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property e_sign (object)

      Configuration for E-signature

    • Deleted property quick_sign (object)

      Configuration for E-signature

PATCH /configuration

Request:

Changed content type : application/json

  • Added property e_sign (object)

  • Deleted property quick_sign (object)

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property e_sign (object)

      Configuration for E-signature

    • Deleted property quick_sign (object)

      Configuration for E-signature

Version 1.1.72Version 1.1.70