Create or Update a Customer

Create a new customer or update an existing customer within the storage system.

createOrUpdateCustomer

POST https://dcams.app/v3/stable/api/storage

Send all of the required fields below and the method will detect whether a create or update is necessary and will signal in the return which one occurred.

Request Body

Name	Type	Description
user	string	Your Veratad API Username
pass	string	Your Veratad API Password
service	string	The service name "createOrUpdateCustomer"
reference	string	A value to be stored in the referecne field
target	object	The target of the query
email	string	The user's email address
fn	string	The user's first name
ln	string	The user's last name
addr	string	The user's street address
city	string	The user's city
state	string	The user's state
zip	string	The user's zip
dob	string	The user's Date of Birth (YYYYMMDD)
phone	string	The user's phone number
documents	object	The document images
front	string	The front document image
back	string	The back document image

200 The customer was found

{
    "result": "Success",
    "reference": "888888812",
    "customer_link": "https://register.veratad.com/admin/customers.php?a=edit&id=727657",
    "status": "PASS",
    "type": "updateCustomer" // possible values "updateCustomer" or "createCustomer"
    "target": {
        "fn": "John",
        "ln": "Smith",
        "addr": "123 Main St",
        "city": "Stratford",
        "state": "CT",
        "zip": "06614",
        "dob": "19700101",
        "email": "[e-mail]",
        "phone": "2015106000"
    }
}

400 The email was not a valid email address

{
    "result": "Error",
    "message": "The email address is invalid"
}

//or

{
    "result": "Error",
    "message": "Missing a required input"
}

401 Either a bad username or password

{
    "result": "Error",
    "message": "Either your username or password is incorrect"
}

404 The customer was not found

{
    "result": "Error",
    "message": "The email address was not found"
}

Sample Request Body

{
    "user": "USERNAME",
    "pass": "PASSWORD",
    "service": "createOrUpdateCustomer",
    "reference": "888888812"
    "target": {
        "email": "[e-mail]",
        "fn": "John",
        "ln": "Smith",
        "addr": "123 Main St",
        "city": "Stratford",
        "state": "CT",
        "zip": "06614",
        "dob": "19700101",
        "phone": "2015106000",
        "documents": {
            "front": "base64 encoded image",
            "back": "base64 encoded image"
        }
    }
}

Response Fields

The response will include all of the target attributes stored within the system for this user, except their document images, and the following varying fields.

attribute	values
result	Success Error
status	PASS PENDING FAIL
type	updateCustomer createCustomer