POST
/
auth
curl --request POST \
  --url https://api.pipevest.com/v1/auth \
  --header 'Content-Digest: <content-digest>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'Signature: <signature>' \
  --header 'Signature-Input: <signature-input>' \
  --header 'X-Idempotency-Id: <x-idempotency-id>' \
  --data clientId=client-id \
  --data clientSecret=client-secret
{
  "data": {
    "accessTokenId": 123456,
    "accessToken": "01937261-e216-754f-99ba-c1170d65dd28",
    "expiresIn": 123,
    "maxTTL": 123,
    "type": "Bearer",
    "scope": [
      "read",
      "write"
    ],
    "trustedIps": [
      "123.123.123.123"
    ],
    "createdAt": 1234567890,
    "updatedAt": 1234567890
  },
  "code": 201,
  "message": "Created"
}

Headers

​
Signature
string
required

Base64 encoded signed hash of the http message request components.

Learn how signatures work

Example:

"sig1=:OTEyMjY4...A5NTNDMEQ=:"

​
Signature-Input
string
required

An ordered list of components that make up the signature base. It is used to recompute and verify the Signature

Learn how signatures work

Example:

"sig1=(\"Content-Type\" \"Content-Digest\" \"Content-Length\" \"Authorization\" \"X-Client-Id\" \"X-Idempotency-Key\" \"@method\" \"@target-uri\" \"@path\" \"@query\");keyid=\"staging-pipevest-ed25519\";created=1732893484;expires=1732893584"

​
X-Idempotency-Id
string
required

Unique identifier passed into each a mutable request (i.e POST, PUT, PATCH, DELETE)

This key isn't not required for GET requests

Example:

"01937261-e216-754f-99ba-c1170d65dd28"

​
Content-Digest
string
required

Base64 encoded sha-512 hash of the http message body.

This key isn't not required for GET and DELETE requests.

Learn how to generate content digest

Example:

"sha-512=:RK/0qy18MlBSVnWgjwz6lZEWjP/lF5HF9bvEF8FabDg=:"

Body

application/x-www-form-urlencoded

Details used to create a customer within the system

The body is of type object.

Response

201
application/json

Details of the access token

The response is of type object.

POST
/
auth
curl --request POST \
  --url https://api.pipevest.com/v1/auth \
  --header 'Content-Digest: <content-digest>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'Signature: <signature>' \
  --header 'Signature-Input: <signature-input>' \
  --header 'X-Idempotency-Id: <x-idempotency-id>' \
  --data clientId=client-id \
  --data clientSecret=client-secret
{
  "data": {
    "accessTokenId": 123456,
    "accessToken": "01937261-e216-754f-99ba-c1170d65dd28",
    "expiresIn": 123,
    "maxTTL": 123,
    "type": "Bearer",
    "scope": [
      "read",
      "write"
    ],
    "trustedIps": [
      "123.123.123.123"
    ],
    "createdAt": 1234567890,
    "updatedAt": 1234567890
  },
  "code": 201,
  "message": "Created"
}

Headers

​
Signature
string
required

Base64 encoded signed hash of the http message request components.

Learn how signatures work

Example:

"sig1=:OTEyMjY4...A5NTNDMEQ=:"

​
Signature-Input
string
required

An ordered list of components that make up the signature base. It is used to recompute and verify the Signature

Learn how signatures work

Example:

"sig1=(\"Content-Type\" \"Content-Digest\" \"Content-Length\" \"Authorization\" \"X-Client-Id\" \"X-Idempotency-Key\" \"@method\" \"@target-uri\" \"@path\" \"@query\");keyid=\"staging-pipevest-ed25519\";created=1732893484;expires=1732893584"

​
X-Idempotency-Id
string
required

Unique identifier passed into each a mutable request (i.e POST, PUT, PATCH, DELETE)

This key isn't not required for GET requests

Example:

"01937261-e216-754f-99ba-c1170d65dd28"

​
Content-Digest
string
required

Base64 encoded sha-512 hash of the http message body.

This key isn't not required for GET and DELETE requests.

Learn how to generate content digest

Example:

"sha-512=:RK/0qy18MlBSVnWgjwz6lZEWjP/lF5HF9bvEF8FabDg=:"

Body

application/x-www-form-urlencoded

Details used to create a customer within the system

The body is of type object.

Response

201
application/json

Details of the access token

The response is of type object.