legalCheck

post

https://api.hyperliquid.xyzhttps://api.hyperliquid-testnet.xyz

/info

Request legal verification status of a user.

Body

application/json

Request legal verification status of a user.

typeundefined · enumRequired

Type of request.

Possible values:

userstring · min: 42 · max: 42Required

User address.

Pattern: ^0[xX][0-9a-fA-F]+$

Responses

200

Legal verification status for a user.

application/json

Legal verification status for a user.

ipAllowedbooleanRequired

Whether the user IP address is allowed.

acceptedTermsbooleanRequired

Whether the user has accepted the terms of service.

userAllowedbooleanRequired

Whether the user is allowed to use the platform.

422

Failed to deserialize the JSON body into the target type

text/plain

500

Internal Server Error

application/json

post

/info

TypeScript

import * as hl from "@nktkas/hyperliquid";

const transport = new hl.HttpTransport(); // or `WebSocketTransport`
const client = new hl.InfoClient({ transport });

const data = await client.legalCheck({ user: "0x..." });

{
  "ipAllowed": true,
  "acceptedTerms": true,
  "userAllowed": true
}