Sign Up

The Sign Up APIs allow a user for customer verification and Create profile and set up security Q&A.

Customer Verification¶

Description

The validateCustomerInfo endpoint is used to validate the customer's information with the customer and invoice number in order to Sign-up with the VELA application.

This endpoint is needed only when the Invoices module is enabled for the merchant.

Request

Endpoint

/ui/v1/validateCustomerInfo

Method

POST

Header

Content-Type: application/json

Attributes

ELEMENT	DESCRIPTION	FORMAT
Customer Number	Required must be at least 5 digits long	12345 Only numerics
InvoiceNumber	Required must be at least 8 characters long	123456R

Request Body

{
    "customerNumber": "10010",
    "invoiceNumber": "160100636",
    "uiType": "OneUI",
    "geolocation": "",
    "merchantCode": "VELA",
    "customerType": {
        "name": "PHYSICIAN",
        "value": ""
    }
}  

Response

{
    "id": null,
    "invoiceNumber": "160100636",
    "createdDateTime": null,
    "lastUpdatedDateTime": null,
    "invoiceDate": null,
    "paidDate": null,
    "dueDate": null,
    "terms": 0,
    "aging": 0,
    "invoiceAmount": null,
    "paidAmount": null,
    "amountDue": null,
    "createdUserId": null,
    "lastModifiedUserId": null,
    "invoiceStatus": {
        "value": "Unpaid",
        "name": "UNPAID"
    },
    "customerId": 10,
    "invoiceBatchId": null,
    "paidByUserId": null,
    "merchantId": null,
    "customerType": {
        "value": "Physician",
        "name": "PHYSICIAN"
    },
    "waiveReasonOnLateFees": null,
    "waiveLateFeesByPercentage": null,
    "waivedByUserId": null,
    "waivedDate": null,
    "customerNumber": "10010",
    "customerName": null,
    "merchantName": null,
    "paidByUserName": null,
    "message": {
        "code": "86",
        "type": {
            "value": "Success",
            "name": "SUCCESS"
        },
        "text": null,
        "include_i_icon": false,
        "description": "The Customer information has been verified and the Guest User is able to login successfully into the application."
    },
    "geolocation": "",
    "channelId": null,
    "roleType": null,
    "paymentAction": null,
    "addressLine1": null,
    "addressLine2": null,
    "city": null,
    "state": null,
    "zipCode": null,
    "phone": null,
    "merchantCode": "VELA"
}  

Updated As Of 4.6.0.3