Create customer

Create a new customer or retrieve an existing one.

Pass a unique id to identify the customer within your system. Optionally include a subject_token (OIDC ID token) to link the customer to an identity provider. If a customer already exists for the given id, it returns the existing customer.

The response includes an access_token JWT used to authenticate customer-scoped requests (external accounts, intents, transactions).

POST /customers

Create customer

cURL

curl --request POST \
  --url https://api.gnosisramp.io/v1/customers \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "user_12345",
  "subject_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "metadata": {}
}
'

201

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "organizationId": "org_123456",
  "projectId": "proj_123456",
  "metadata": {},
  "access_token": "<string>"
}

Authorizations

Authorization · string · header · required

HTTP Basic authentication using project clientId and clientSecret

Body

application/json

Request body for customer creation

id · string · required

Unique customer identifier within your system

Example:

"user_12345"

subject_token · string

Optional OIDC ID token for identity provider linking

Example:

"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."

metadata · object

Optional metadata to associate with the customer

Response

201

application/json

Customer created or retrieved successfully

Customer entity

id · string<uuid> · required

Unique customer identifier

Example:

"550e8400-e29b-41d4-a716-446655440000"

createdAt · string<date-time> · required

Customer creation timestamp

Example:

"2024-01-01T00:00:00.000Z"

updatedAt · string<date-time> · required

Customer last update timestamp

Example:

"2024-01-01T00:00:00.000Z"

organizationId · string · required

Organization identifier

Example:

"org_123456"

projectId · string · required

Project identifier

Example:

"proj_123456"

metadata · object

Additional customer metadata

access_token · string | null

GnosisRamp JWT token for authenticated customer requests