Skip to main content

Pin

The pin type defines a PIN code that can be displayed as part of the issuance. Pin is optional, and, if used, should always be sent out-of-band. When you're using a HASH PIN code, you must define the salt, alg, and iterations properties.

input Pin {
  alg: String
  iterations: PositiveInt
  length: PositiveInt
  salt: String
  type: String
  value: String!
}

Fields​

Pin.alg ● String scalar​

The hashing algorithm for the hashed PIN. Supported algorithm: sha256.

Pin.iterations ● PositiveInt scalar​

The number of hashing iterations. Possible value: 1.

Pin.length ● PositiveInt scalar​

The length of the PIN code. The default length is 6, the minimum is 4, and the maximum is 16.

Pin.salt ● String scalar​

The salt of the hashed PIN code. The salt is prepended during hash computation. Encoding: UTF-8.

Pin.type ● String scalar​

The type of the PIN code. Possible value: numeric (default).

Pin.value ● String! non-null scalar​

Contains the PIN value in plain text. When you're using a hashed PIN, the value property contains the salted hash, base64 encoded.

Member Of​

IssuanceRequestInput input