Request

POST http:///api/v1/partner/user/register

Request body

The request body takes a complete ConsumerCreateRequest resource, containing the following writable properties:

{
    "agreement": {
        "active": "boolean",
        "assetType": "string",
        "companyId": "string",
        "created": "int64",
        "deleted": "boolean",
        "id": "string",
        "key": "string",
        "largeURL": "string",
        "largeX2URL": "string",
        "mediumURL": "string",
        "modified": "int64",
        "name": "string",
        "origURL": "string",
        "priority": "int32",
        "publicURL": "string",
        "secured": "boolean",
        "thumbURL": "string",
        "type": "string",
        "updated": "boolean"
    },
    "contractId": "string",
    "dob": "int64",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "marketingSource": "string",
    "password": "string",
    "phoneNumber": "string",
    "sex": "string"
}

Properties

Name Type Description Additional
agreement object CompanyAsset Optional
agreement.active boolean Optional
agreement.assetType string

Possible values are:

  • Photo
  • Document
  • Kml
Optional
agreement.companyId string Optional
agreement.created int64 Optional
agreement.deleted boolean Optional
agreement.id string Optional
agreement.key string Optional
agreement.largeURL string Optional
agreement.largeX2URL string Optional
agreement.mediumURL string Optional
agreement.modified int64 Optional
agreement.name string Optional
agreement.origURL string Optional
agreement.priority int32 Optional
agreement.publicURL string Optional
agreement.secured boolean Optional
agreement.thumbURL string Optional
agreement.type string

Possible values are:

  • Photo
  • Document
  • Kml
Optional
agreement.updated boolean Optional
contractId string Optional
dob int64 Optional
email string Optional
firstName string Optional
lastName string Optional
marketingSource string Optional
password string Optional
phoneNumber string Optional
sex string

Possible values are:

  • MALE
  • FEMALE
  • OTHER
Optional

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

successful operation

ConsumerUser

Explore this API

body
Request Content-Type
Response Content-Type
Try it out!