v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Enrollment Payment Initiation

Gets enrollment FIDO registration options.

Method for getting enrollment FIDO registration options.

post/baas/v1/open/itp/enrollments/payment-initiation/{itp_enrollment_id}/fido-registration-options

Path parameters

itp_enrollment_idstring required

ID is the unique identifier of the ITP

Request body

Example request

{
  "data": {
    "platform": "ANDROID"
  }
}

Response

Object containing the necessary information for registering a new FIDO2 credential.

enrollmentIdstring required

| Unique identifier of the account enrollment created for the requested payment initiation. Must be a URN - Uniform Resource Name. A URN, as defined in RFC8141, is a Uniform Resource Identifier - URI - that is assigned under the URI scheme "urn" and a specific URN namespace, with the intention that the URN be a persistent and location-independent resource identifier. Considering the string urn:bancoex:C1DD33123 as an example for enrollmentId we have: - the namespace (urn) - the identifier associated with the account holder institution namespace (bancoex) - the specific identifier within the namespace (C1DD33123). More detailed information about namespace construction should be consulted in RFC8141.

challengestring required

Random byte sequence generated by the FIDO2 server. Must be the value in base64url format without padding.

timeoutinteger

Timeout, in milliseconds, for FIDO2 credential registration.

attestationstring

Indicates the type of attestation that the authenticator can use.

attestationFormatsstring[]

Indicates format preferences over the attestation field.

extensionsobject

| Optional extension field for additional FIDO2/WebAuthn functionality that varies by platform and implementation. Common extensions include: • credProps: Request additional credential properties (if it's resident/discoverable) • minPinLength: Request the authenticator's minimum PIN length • largeBlob: Allow storing/retrieving blobs associated with the credential • payment: Support for secure payment confirmation • appid: For compatibility with legacy FIDO U2F credentials

			Format: JSON object where each property represents a specific extension.
			Not all extensions are supported by all browsers/authenticators.

Example response

{
  "enrollmentId": "urn:bancoex:C1DD33123",
  "pubKeyCredParams": [
    {
      "type": "public-key"
    }
  ],
  "timeout": 123,
  "excludeCredentials": [
    {
      "type": "public-key"
    }
  ],
  "authenticatorSelection": {
    "authenticatorAttachment": "platform, cross-platform",
    "userVerification": "discouraged, preferred, required"
  },
  "attestation": "none, indirect, direct, enterprise"
}