Skip to content

Get in-person verification readiness

GET
/in-person/session
curl --request GET \
--url https://api.ethos.network/api/v2/in-person/session \
--header 'Authorization: Bearer <token>'

For the Verify service, called with the person’s own Privy token before a ceremony starts: their profile, whether they may verify, whether their Ethos wallet can submit the bond, the IN_PERSON_VERIFICATION gate and, given subjectUserkey, whether a bond on that person would be refused. Read-only.

subjectUserkey
string

Successful response

Media typeapplication/json
object
gateOpen
required

IN_PERSON_VERIFICATION for the caller.

boolean
privyUserId
required
string
profile
required
Any of:
object
avatarUrl
required
string | null
displayName
required
string
humanVerificationStatus
required
Any of:
string
Allowed values: PENDING REQUESTED VERIFIED REVOKED
profileId
required
integer
>= -9007199254740991 <= 9007199254740991
score
required
integer
>= -9007199254740991 <= 9007199254740991
userkey
required
string
stake
required
object
canStake
required
boolean
reason
required
Any of:
string
Allowed values: GATED INSUFFICIENT_FUNDS NO_EMBEDDED_WALLET WALLET_NOT_ON_PROFILE
subject
required
Any of:
object
bonds
required

Active human-verification bonds on the subject, one per verifier.

Array<object>
object
authorProfileId
required
integer
>= -9007199254740991 <= 9007199254740991
id
required
integer
>= -9007199254740991 <= 9007199254740991
bondsRequired
required
integer
>= -9007199254740991 <= 9007199254740991
canBeBonded
required
boolean
humanVerificationStatus
required
Any of:
string
Allowed values: PENDING REQUESTED VERIFIED REVOKED
profileId
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
reason
required
Any of:
string
Allowed values: ALREADY_BONDED NO_PROFILE NOT_FOUND REVOKED SELF
userkey
required
string
verifier
required
object
bondAmount
required
integer
>= -9007199254740991 <= 9007199254740991
eligible
required
boolean
reason
required
Any of:
string
Allowed values: BLOCKED NO_PROFILE NOT_HUMAN_VERIFIED SCORE_TOO_LOW

Example

{
"profile": {
"humanVerificationStatus": "PENDING"
},
"stake": {
"reason": "GATED"
},
"subject": {
"humanVerificationStatus": "PENDING",
"reason": "ALREADY_BONDED"
},
"verifier": {
"reason": "BLOCKED"
}
}

Invalid input data

Media typeapplication/json
Invalid input data error (400)

The error information

object
message
required

The error message

string
code
required

The error code

string
issues

An array of issues that were responsible for the error

Array<object>
object
message
required
string

Example

{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}

Authorization not provided

Media typeapplication/json
Authorization not provided error (401)

The error information

object
message
required

The error message

string
code
required

The error code

string
issues

An array of issues that were responsible for the error

Array<object>
object
message
required
string

Example

{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}

Insufficient access

Media typeapplication/json
Insufficient access error (403)

The error information

object
message
required

The error message

string
code
required

The error code

string
issues

An array of issues that were responsible for the error

Array<object>
object
message
required
string

Example

{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}

Not found

Media typeapplication/json
Not found error (404)

The error information

object
message
required

The error message

string
code
required

The error code

string
issues

An array of issues that were responsible for the error

Array<object>
object
message
required
string

Example

{
"code": "NOT_FOUND",
"message": "Not found",
"issues": []
}

Internal server error

Media typeapplication/json
Internal server error error (500)

The error information

object
message
required

The error message

string
code
required

The error code

string
issues

An array of issues that were responsible for the error

Array<object>
object
message
required
string

Example

{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}