Terms And Conditions

Saves user's approval latest terms and conditions

post

https://api.obol.techhttp://localhost:3000https://localhost:3000

/v1/termsAndConditions

Saves user's signature to latest Obol's terms and conditions hash and it's version

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

authorizationstringRequired

EIP712 terms and conditions hash as bearer token

Body

application/json

addressstringRequiredExample: v1.0.0

versionnumberRequiredExample: 1

terms_and_conditions_hashstringRequired

fork_versionstring · enumOptionalExample: 0x00000000Possible values:

Responses

201

success message

No content

400

Invalid terms and conditions hash

401

Signature verification failed

500

An unknown error occurred

post

/v1/termsAndConditions

HTTPcURLJavaScriptPython

POST /v1/termsAndConditions HTTP/1.1
Host: api.obol.tech
Authorization: Bearer YOUR_SECRET_TOKEN
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "address": "v1.0.0",
  "version": 1,
  "terms_and_conditions_hash": "",
  "fork_version": "0x00000000"
}

No content

Verify Signature on Terms and Conditions

get

https://api.obol.techhttp://localhost:3000https://localhost:3000

/v1/termsAndConditions/{address}

This endpoint is used to check whether the Terms and Conditions has been signed by the user.

Path parameters

addressstringRequired

The address to check the Terms and Conditions.

Responses

200

This value returns true if the Terms and Conditions have been signed; otherwise, it returns false.

application/json

400

The Address provided is not valid

500

An unknown error occurred

get

/v1/termsAndConditions/{address}

HTTPcURLJavaScriptPython

GET /v1/termsAndConditions/{address} HTTP/1.1
Host: api.obol.tech
Accept: */*

{
  "isTermsAndConditionsSigned": true
}