Skip to main content
POST
/
v1
/
platform
/
users
Add a New User
curl --request POST \
  --url https://api-sandbox.finogates.com/v1/platform/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "email": "jsmith@example.com"
}
'
{
  "status_code": 123,
  "data": "<unknown>",
  "query_generated_time": 123
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Create a new end user on the platform.

name
string
required

Full name of the user.

Required string length: 1 - 100
Example:

"John Doe"

email
string<email>
required

User's email address. Must be unique within the platform and RFC 5321 compliant.

Maximum string length: 254
Example:

"john.doe@example.com"

Response

Successful Response

Standard response wrapper for single-object responses and errors.

Generic over the payload type. A route that declares CommonResponse[SomeModel] gets the real data schema rendered in OpenAPI/Swagger; a bare CommonResponse leaves data untyped.

status_code
integer
required

HTTP status code for the response.

data
any
required

Payload or error details.

query_generated_time
integer
required

UTC timestamp (milliseconds since epoch) when response was generated.