neatcar

Endpoint

Create account

The Create Account endpoints allow the creation of new user accounts within the Neatcar platform. These accounts are necessary for accessing user-specific features such as login, credit card management, and carwash history. Each user created is automatically linked to the reseller account used to perform the creation. Once an account is successfully created, it can be used to generate a user token via the login endpoint, enabling access to protected endpoints that require user authentication.

POST

/user

Body

The externalReferenceId is a unique identifier that the client needs to provide in order to ensure that the account creation request is idempotent. If the account already exists, the request will be ignored and the existing account will be returned.

The associatedBrandName is an optional parameter that the client can provide to associate the account with a specific brand. This brand could be used to display the brand information in the user interface, help for support, keep tracability for ownership, etc. The associatedBrandName need to match a brand that is already defined in the system.

User Model data

The following list provides a selection of key values included in the model; however, it is non-exhaustive. Developers can expect to find additional fields and data within the model, offering comprehensive information about each user. This abbreviated list serves as a starting point for understanding the structure of the model and the types of information available for each user.

uuid
Unique identifier for the user
associatedBrandName
The name of the brand associated with the user
externalReferenceId
The unique identifier for the client for the user
communicationEmail
The email used for communication with the user (transactional emails, etc.)
firstName
The first name of the user
lastName
The last name of the user

Response example

Below is an example of the API endpoint response, showcasing the structure and format of the data returned by the specified endpoint. This example serves as a practical illustration, demonstrating how developers can expect the information to be organized and presented when interacting with the API. It provides insight into the content and layout of the response, facilitating effective integration and utilization of the endpoint within your applications.

Possible errors

The following list provides a selection of possible errors that can occur when creating an account. However, it is non-exhaustive. Developers can expect to find additional errors and data within the model, offering comprehensive information about each error.

HTTP 400

Bad Request due to invalid or missing API token

Without the API token, the request is interpreted as an attempt to create a new neatcar user without reseller ownership, which require different parameters.

Error body response example: 

  







  

    

      HTTP 400
      
Bad Request due to missing parameters

    

    
    
  

  
When the API token is valid and present, this error is returned when the request contains missing parameters to be processed.

  Error body response example:
  

    

  







  

    

      HTTP 500
      
Internal Server Error

    

    
    
  

  
An unexpected error occurred while processing the request. Please try again later or contact support if the problem persists.

  Error body response example: