For the complete documentation index, see llms.txt. This page is also available as Markdown.

Human Verification

get

Returns human verifications matching the given search criteria.

Query parameters
connectionScopestring · enumOptional

Narrow the pool to the viewer's connections. 'all' = no filter; 'following' = subjects the viewer follows on X; 'network' = subjects in the viewer's "people you know" set (connection degrees 1st/2nd/3rd-subject). Falls back to 'all' without an authenticated viewer.

Default: allPossible values:
followsScopestring · enumOptionalPossible values:
minScoreinteger · max: 2800Optional
searchstring · min: 2 · max: 100Optional
sortBystring · enumOptionalDefault: newestPossible values:
sortOrderstring · enumOptionalDefault: descPossible values:
statusany ofOptionalDefault: ["REQUESTED"]
string · enumOptionalPossible values:
or
minVerificationsinteger · max: 2Optional
limitinteger · max: 50OptionalDefault: 50
offsetinteger · max: 2147483647OptionalDefault: 0
Responses
200

Successful response

application/json
totalnumberRequired
limitnumberRequired
offsetnumberRequired
get/human-verification/search

Get human verifications created by the current user

get

Returns human verifications where the subject has a bond created by the authenticated user.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
limitinteger · max: 50OptionalDefault: 50
offsetinteger · max: 2147483647OptionalDefault: 0
Responses
200

Successful response

application/json
totalnumberRequired
limitnumberRequired
offsetnumberRequired
get/human-verification/my-verifications

Get human verification bonds

get

Returns all HUMAN bonds with subject and actor info, ordered by creation date descending.

Query parameters
limitinteger · max: 50OptionalDefault: 50
offsetinteger · max: 2147483647OptionalDefault: 0
Responses
200

Successful response

application/json
totalnumberRequired
limitnumberRequired
offsetnumberRequired
get/human-verification/verifications

Request human verification

post

Creates a human verification request for the authenticated user. Idempotent - succeeds if already requested.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

Successful response

application/json
successbooleanRequired
post/human-verification/request

Search eligible human verifiers

get

Returns eligible verifiers sorted by proximity to the current user. Used by requesters to find verifiers to reach out to.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
searchstring · min: 2 · max: 100Optional
limitinteger · max: 50OptionalDefault: 50
offsetinteger · max: 2147483647OptionalDefault: 0
Responses
200

Successful response

application/json
totalnumberRequired
limitnumberRequired
offsetnumberRequired
get/human-verification/verifiers

Get human verification info for a subject

get

Returns the human verification status, expiration, and any bonds where the subject is being verified. Accepts profile-userkeys (profileId:<n>) or X-account userkeys (service:x.com:<id>).

Path parameters
subjectUserkeyany ofRequired
stringOptional
or
stringOptional
Responses
200

Successful response

application/json
connectionDegreestring · enum · nullableRequiredPossible values:
createdAtstringRequired
expiresAtstring · nullableRequired
hasSelfDeclaredBondbooleanRequired
idinteger · max: 9007199254740991 · nullableRequired
selfDeclaredBondIdinteger · max: 9007199254740991 · nullableRequired
statusstring · enum · nullableRequiredPossible values:
verifiedAtstring · nullableRequired
viewerFollowsThembooleanRequired
get/human-verification/{subjectUserkey}

Create a signature for a human verification bond

post

Creates a signed payload for submitting a HUMAN bond to the blockchain. The caller must then submit the bond to the blockchain themselves.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
subjectProfileIdinteger · max: 9007199254740991Optional
subjectUserkeyany ofOptional
stringOptional
or
stringOptional
verificationMethodstring · enumRequiredPossible values:
commentstring · min: 1Required
Responses
200

Successful response

application/json
statementstringRequired
expirationstringRequired
amountstringRequired
amountTypestringRequired
metadatastringRequired
randValuenumberRequired
signaturestringRequired

65-byte ECDSA signature (0x-prefixed hex, 132 chars)

bondTypeconst: HUMAN_VERIFICATIONRequired
post/signatures/humanity-bond

Create a signature for a self-declared human bond

post

Creates a signed payload for submitting a self-declared HUMAN bond to the blockchain. Any user with an Ethos profile can create one. Limited to one per profile.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

Successful response

application/json
statementstringRequired
expirationstringRequired
amountstringRequired
amountTypestringRequired
metadatastringRequired
randValuenumberRequired
signaturestringRequired

65-byte ECDSA signature (0x-prefixed hex, 132 chars)

bondTypeconst: SELF_DECLARED_HUMANRequired
post/signatures/self-declared-humanity-bond

Last updated