Create Owner

The Create Owner endpoint allows you to create an owner object for a user in the Home Tracker API. Upon successful creation, the endpoint returns a userID token that uniquely identifies the newly created object. This token will be used for subsequent operations in the Home Tracker API.

Endpoint

POST /create-owner

Description

This endpoint creates an owner object for a user and generates a userID token. This token serves as a unique identifier for the owner object. It is important to securely store and associate this token with your own representation of the customer.

Request Inputs

The Create Owner endpoint requires the following inputs in the request payload:

{
  "firstName": "John",
  "lastName": "Doe",
  "address": "123 Main St Anytown, NY 12345",
}
  • firstName (string): The first name of the owner.
  • lastName (string): The last name of the owner.
  • address (string): The address of the owner.

Response

Upon successful creation, the endpoint will return a ownerID token that represents the newly created owner object.

Example Response

{
  "ownerID": "abcd1234"
}

Owner Verification

Once you have created an owner, you can use the Owner Verification function to associate a property with the owner. This ensures that the owner is linked to the respective property within the Home Tracker API.

For more information on owner verification, please refer to the documentation for the Verify Owner endpoint.

Conclusion

This API documentation provides an overview of the Create Owner endpoint in the Chimney API. By using this endpoint, you can create an owner object for a user and obtain a ownerID token for subsequent operations. Make sure to securely store and associate the ownerID token with your customer representation. For more detailed information on request/response formats and available parameters, refer to the specific endpoint documentation.