Create Open Finance account enrollment for PIX payment initiation

Initiates the Open Finance Brasil account linking process (enrollment) that enables PIX payment initiation without user redirection to the account holder institution. This creates a secure, persistent connection between the payment initiator and the account holder through a comprehensive flow involving user authentication, risk signal collection, consent management, and FIDO2 credential binding. The process includes: 1) User identity verification with CPF/CNPJ, 2) Device risk signals collection for fraud prevention, 3) OAuth2 consent creation with the account holder, 4) FIDO2 biometric/PIN credential registration, 5) Account link authorization. Once established, this enrollment enables seamless PIX payments without repeated user authentication at the account holder.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 0 and 36

Unique identifier of the financial institution brand where the account enrollment will be created

string
length between 0 and 36

ID is the unique identifier of journey

uri
required
length between 0 and 999999

Authorized callback URL where the user will be redirected after completing the enrollment authorization process at the account holder institution

boolean

Indicates whether the redirection comes directly from the Open Finance Brasil directory or from a payment initiation flow

string
length between 0 and 140

Custom name for the device or authorization method used by the user during the enrollment process. This field allows for user-friendly identification of the specific device that will be used for FIDO2 authentication and payment authorization. [Restriction] Must be filled whenever the payer user enters any information about the authorization device name during the account linking flow.

string
length between 0 and 999999

Tags que podem ser usadas para classificar a sessão da jornada.

data
object
required

Complete enrollment data containing user authentication information and device risk signals required for secure account linking process

Responses

Language
Credentials
OAuth2
Missing 2 required scopes
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json