Check company name availability

Checks if a company name is already taken in the system. Requires authentication. Rate limited to 3 requests per minute per user.

POST/v1/customers/check-name

Authorization

bearerAuth

AuthorizationBearer <token>

JWT token obtained from /v1/authenticate endpoint

In: header

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Company name to check for availability

curl -X POST "https://example.com/v1/customers/check-name" \  -H "Content-Type: application/json" \  -d '{    "name": "Acme Corporation"  }'

{
  "available": true,
  "name": "Acme Corporation"
}

{
  "error": {
    "code": "string",
    "message": "string",
    "key": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "key": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "key": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "key": "string"
  }
}