POST
/
api
/
v1
/
ventures
Register a New Venture
curl --request POST \
  --url http://localhost:8080/api/v1/ventures \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'
{
  "api_key": "<string>",
  "api_key_prefix": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>"
}

Body

application/json

Request to register a new venture.

​
name
string
required

Response

Venture created; API key returned ONCE

Response returned once at creation. The plaintext api_key is shown exactly ONCE and cannot be retrieved later.

​
api_key
string
required

Plaintext API key — store it now; it cannot be retrieved again.

​
api_key_prefix
string
required
​
created_at
string<date-time>
required
​
id
string<uuid>
required
​
name
string
required
​
status
enum<string>
required

Whether a venture may authenticate and transact.

Available options:
ACTIVE,
DISABLED