API OverviewAPI EndpointsEntities

Create a new entity

Creates a new entity with the provided details

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
developerIdstringRequired
ID of the developer creating the entity
externalIdstringOptional
External identifier for the entity
legalNamestringOptional
Legal name of the entity
tinstringOptional
Tax Identification Number
usStatestringOptional
US state code
entityTypestringOptional
Type of entity
phoneNumberstringOptional
Contact phone number
statusstringOptional
Current status of the entity
clerkIdstringOptional

Clerk ID (alternative to developerId)

dateCreatedstringOptionalformat: "date-time"
When the entity was created
instanceIdstringOptional
ID of the instance to associate with the entity

Response

Entity created successfully
entityobject or null

Errors