Create account [Phasing In - V2]

Create an account on the system that represents a leasing company, vehicle user or hybrid account. We also need basic contact and address information

Request

POST http:///fleet.roadprotect.co.il/api/v1/account/v2

Request body

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

{
    "details": {
        "fax": "string",
        "name": "string",
        "reportingEmbedUrl": "string"
    },
    "identifier": "string",
    "name": "string",
    "physicalLocation": {
        "city": "string",
        "code": "string",
        "country": "string",
        "proximity": "string",
        "streetName": "string",
        "streetNumber": "string"
    },
    "postalLocation": {
        "city": "string",
        "code": "string",
        "country": "string",
        "postOfficeBox": "string",
        "proximity": "string"
    },
    "primaryContact": "string",
    "role": "string"
}

Properties

Name Type Description Additional
details object AccountDetails
details.fax string
details.name string
details.reportingEmbedUrl string
identifier string

The identifier or business registration of the account
name string

The name of the group / business / company
physicalLocation object CreatePhysicalLocationDto
physicalLocation.city string
physicalLocation.code string Optional
physicalLocation.country string
physicalLocation.proximity string Optional
physicalLocation.streetName string Optional
physicalLocation.streetNumber string Optional
postalLocation object CreatePostalLocationDto
postalLocation.city string
postalLocation.code string Optional
postalLocation.country string
postalLocation.postOfficeBox string
postalLocation.proximity string Optional
primaryContact string

The email address of the primary contact for this account
role string

The primary role of the account, whether it functions primarily as a vehicle owner [Owner], user [User] or both [Hybrid]

Possible values are:

  • Owner
  • User
  • Hybrid

Authorisation

To authenticate your client integration please put your token in the header of your requests with the key Authorization, it should look like this:

Authorization: Bearer YOUR_TOKEN_HERE

Please keep your token secured. If your token is compromised, we can issue a new token for you.

This request requires the use of one of following authorisation methods: API key .

Response

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

Status code Description Resource
201 Created Account
400 Bad Request

E117: No valid locations were provided, neither Postal nor Physical
500 Internal Server Error

Database error. Failed to perform that action, please contact support.