Returns the user information based on the email address

GET /users

Returns the user information based on the email address

Query parameters

  • email string Required

    User email

Responses

  • 200

    User information

    Hide response attributes Show response attributes object
    • id string(uuid)
    • user_code string
    • email string
    • locale string
    • terms_acceptance boolean
    • email_confirmed boolean
    • approved_at string(datetime)
    • rejected_at string(datetime)
    • created_at string(datetime)
    • business_investor boolean
    • kyc_status string
    • approved boolean
    • rejected boolean
    • invested boolean
    • identities object
      Hide identities attributes Show identities attributes object
      • id string(uuid)
      • user_id string(uuid)
      • company_role string
      • tax_id_number string
      • first_name string
      • last_name string
      • gender string
      • phone_number string
      • citizenship string

        two-letter country codes in ISO 3166-1 alpha-2 format

      • country_of_birth string

        two-letter country codes in ISO 3166-1 alpha-2 format

      • date_of_birth string(datetime)
      • video_identification_completed_at string(datetime)
      • place_of_birth string
      • family_status string
      • not_us_income_tax boolean
      • trading_on_behalf_of_self boolean
      • title string
      • name_affix string
      • mifid_status string

        Values are skipped, passed, or failed.

      • name_at_birth string
      • second_citizenship string

        two-letter country codes in ISO 3166-1 alpha-2 format

      • country_of_taxation string

        two-letter country codes in ISO 3166-1 alpha-2 format

      • second_country_of_taxation string

        two-letter country codes in ISO 3166-1 alpha-2 format

      • second_tax_id_number string
      • share number(decimal)
      • sole_right_of_representation boolean
      • exclusively_taxable_in_country_of_taxation boolean
      • type string
      • video_identification_completed boolean
      • address object
        Hide address attributes Show address attributes object
        • id string(uuid)
        • street_additional string
        • city string
        • country string

          two-letter country codes in ISO 3166-1 alpha-2 format

        • state string
        • street string
        • number string
        • zipcode string
      • video_identifications array[object]
        Hide video_identifications attributes Show video_identifications attributes array[object]
        • id string(uuid)
        • identity_id string(uuid)
        • idnow_id string
        • redirect_url string
        • statuses array[string]
        • data object
        • url string
        • has_files boolean
        • completed boolean
        • success boolean
        • rejected boolean
        • pending boolean
        • reason string
        • identificationtime string(datetime)
        • status string
      • attachments array[object]
        Hide attachments attributes Show attachments attributes array[object]
        • id string(uuid)
        • file object
        • filename string
        • document_type string
        • document_id_number string
        • issued_at string(datetime)
        • expires_at string(datetime)
        • issuing_authority string
        • issuing_country string
        • content_type string
      • term object
        Hide term attributes Show term attributes object
        • custody_wallet_terms_acceptance boolean
        • custody_wallet_privacy_acceptance boolean
GET /users
curl \
 -X GET https://client-subdomain.bitbond.net/api/v1/users?email=string
Response examples (200)
{
  "id": "string",
  "user_code": "string",
  "email": "string",
  "locale": "string",
  "terms_acceptance": true,
  "email_confirmed": true,
  "approved_at": "string",
  "rejected_at": "string",
  "created_at": "string",
  "business_investor": true,
  "kyc_status": "string",
  "approved": true,
  "rejected": true,
  "invested": true,
  "identities": {
    "id": "string",
    "user_id": "string",
    "company_role": "string",
    "tax_id_number": "string",
    "first_name": "string",
    "last_name": "string",
    "phone_number": "string",
    "citizenship": "string",
    "country_of_birth": "string",
    "date_of_birth": "string",
    "video_identification_completed_at": "string",
    "place_of_birth": "string",
    "family_status": "string",
    "gender": "string",
    "not_us_income_tax": true,
    "trading_on_behalf_of_self": true,
    "title": "string",
    "name_affix": "string",
    "mifid_status": "skipped",
    "name_at_birth": "string",
    "second_citizenship": "string",
    "country_of_taxation": "string",
    "second_country_of_taxation": "string",
    "second_tax_id_number": "string",
    "share": 42.0,
    "sole_right_of_representation": true,
    "exclusively_taxable_in_country_of_taxation": true,
    "type": "string",
    "video_identification_completed": true,
    "address": {
      "id": "string",
      "street_additional": "string",
      "city": "string",
      "country": "string",
      "state": "string",
      "street": "string",
      "number": "string",
      "zipcode": "string"
    },
    "video_identifications": [
      {
        "id": "string",
        "identity_id": "string",
        "idnow_id": "string",
        "redirect_url": "string",
        "statuses": [
          "string"
        ],
        "data": {},
        "url": "string",
        "has_files": true,
        "completed": true,
        "success": true,
        "rejected": true,
        "pending": true,
        "reason": "string",
        "identificationtime": "string",
        "status": "string"
      }
    ],
    "attachments": [
      {
        "id": "string",
        "file": {},
        "filename": "string",
        "document_type": "string",
        "document_id_number": "string",
        "issued_at": "string",
        "expires_at": "string",
        "issuing_authority": "string",
        "issuing_country": "string",
        "content_type": "string"
      }
    ],
    "term": {
      "custody_wallet_terms_acceptance": true,
      "custody_wallet_privacy_acceptance": true
    }
  }
}
Response examples (200)
{
  "id": "string",
  "user_code": "string",
  "email": "string",
  "locale": "string",
  "terms_acceptance": true,
  "email_confirmed": true,
  "approved_at": "string",
  "rejected_at": "string",
  "created_at": "string",
  "business_investor": true,
  "kyc_status": "string",
  "approved": true,
  "rejected": true,
  "invested": true,
  "identities": {
    "id": "string",
    "user_id": "string",
    "company_role": "string",
    "tax_id_number": "string",
    "first_name": "string",
    "last_name": "string",
    "gender": "string",
    "phone_number": "string",
    "citizenship": "string",
    "country_of_birth": "string",
    "date_of_birth": "string",
    "video_identification_completed_at": "string",
    "place_of_birth": "string",
    "family_status": "string",
    "not_us_income_tax": true,
    "trading_on_behalf_of_self": true,
    "title": "string",
    "name_affix": "string",
    "mifid_status": "skipped",
    "name_at_birth": "string",
    "second_citizenship": "string",
    "country_of_taxation": "string",
    "second_country_of_taxation": "string",
    "second_tax_id_number": "string",
    "share": 42.0,
    "sole_right_of_representation": true,
    "exclusively_taxable_in_country_of_taxation": true,
    "type": "string",
    "video_identification_completed": true,
    "address": {
      "id": "string",
      "street_additional": "string",
      "city": "string",
      "country": "string",
      "state": "string",
      "street": "string",
      "number": "string",
      "zipcode": "string"
    },
    "video_identifications": [
      {
        "id": "string",
        "identity_id": "string",
        "idnow_id": "string",
        "redirect_url": "string",
        "statuses": [
          "string"
        ],
        "data": {},
        "url": "string",
        "has_files": true,
        "completed": true,
        "success": true,
        "rejected": true,
        "pending": true,
        "reason": "string",
        "identificationtime": "string",
        "status": "string"
      }
    ],
    "attachments": [
      {
        "id": "string",
        "file": {},
        "filename": "string",
        "document_type": "string",
        "document_id_number": "string",
        "issued_at": "string",
        "expires_at": "string",
        "issuing_authority": "string",
        "issuing_country": "string",
        "content_type": "string"
      }
    ],
    "term": {
      "custody_wallet_terms_acceptance": true,
      "custody_wallet_privacy_acceptance": true
    }
  }
}