Sign in

v1

latestOpenAPI 3.1.02026-08-04751,1671.3 MB
End Users

Create End User

Create a new end user.

post/api/v1/end-users

Request body

external_idstring required

The ID that you assign to an end user.

Response

Successful Response

idstring uuid required

The unique identifier of the object in the Fordefi platform.

created_atstring date-time required

The date and time when the object was created.

modified_atstring date-time required

The date and time when the object was last modified. Any change to any field of the resource is considered a modification.

external_idstring required

The ID that you assigned to the end user.

last_login_atstring date-time required

The timestamp when the end user last logged into the mobile SDK.

desired_key_typesKeyType[]

Desired key types. This field is populated by the user during keyset generation.

keyset_idstring uuid required

The unique identifier of the keyset.

auth_public_keystring

The public key of the user's auth-key.

encrypted_device_auth_keystring

An encrypted backup of the user's auth-key.

last_backup_atstring date-time required

The last time backup was intitated.

export_allowedboolean required

Whether the user is allowed to export the keyset.

last_export_atstring date-time required

The last time the keyset was exported.

Example response

{
  "external_id": "user|1234",
  "ecdsa": {
    "encrypted_shares": {
      "device": "SGVsbG8=",
      "platform": [
        "SGVsbG8="
      ]
    },
    "chain_code": "SGVsbG8="
  },
  "eddsa": {
    "encrypted_shares": {
      "device": "SGVsbG8=",
      "platform": [
        "SGVsbG8="
      ]
    },
    "chain_code": "SGVsbG8="
  },
  "ecdsa_stark": {
    "encrypted_shares": {
      "device": "SGVsbG8=",
      "platform": [
        "SGVsbG8="
      ]
    },
    "chain_code": "SGVsbG8="
  },
  "schnorr_secp256k1": {
    "encrypted_shares": {
      "device": "SGVsbG8=",
      "platform": [
        "SGVsbG8="
      ]
    },
    "chain_code": "SGVsbG8="
  },
  "auth_public_key": "SGVsbG8=",
  "encrypted_device_auth_key": "SGVsbG8=",
  "encrypted_device_shares_backups": [
    {
      "ecdsa": "SGVsbG8=",
      "eddsa": "SGVsbG8=",
      "ecdsa_stark": "SGVsbG8=",
      "schnorr_secp256k1": "SGVsbG8=",
      "auth_key": "SGVsbG8="
    }
  ]
}