Documentation Index
Fetch the complete documentation index at: https://docs.clearline.me/llms.txt
Use this file to discover all available pages before exploring further.
POS New Account Registration
Endpoint to start new account registration.
Starts a new account registration
**POST ** https://apitest.clearline.me/v2/pos/{posSystemId}/integrations/account/newRegistration
| Name | Value | Description |
|---|
| Authorization | Bearer access_token | Request authorization header |
| Content-Type | application/json | Content type |
Input parameters
| Field name | Description |
|---|
| posSystem | The identifier of the POS system (e.g., pax, clover) |
Request
{
"subscriptionPlanCode": "string",
"sendToEmail": "user@example.com",
"configuration": {
"posCompanyId": "string",
"posLocationId": "string",
"externalUserId": "string",
"terminalId": "string"
},
"profile": {
"firstName": "string",
"lastName": "string",
"email": "user@example.com",
"phoneNumber": "string",
"state": "string",
"address": "string",
"city": "string",
"zip": "string",
"companyName": "string",
"website": "string"
}
}
Request parameters
| Field name | Description |
|---|
| subscriptionPlanCode | Subscription plan code, as a sample can be used 157AJME5XDSE2 |
| sendToEmail | Email where registration email should be sent |
| configuration | New Registration configuration block |
| posCompanyId | Pos company identifier (External company Identifier ) |
| posLocationId | Pos location identifier (External location Identifier ) |
| externalUserId | External user identifier |
| terminalId | Terminal identifier |
| configuration | Data Block |
| firstName | Contact person first name |
| lastName | Contact person last name |
| email | Company email |
| phoneNumber | Company phone number |
| state | Company location state |
| address | Company address |
| city | Company city |
| zip | Company zip-code |
| companyName | Company name |
| website | Company web-site |
