V1GetEnrollmentByIdRestResponse

id stringrequired

Enrollment UUID.

status stringrequired

Possible values: [PENDING, ERROR, FAILED, AWAITING_DEVICE_RISK_SIGNALS, AWAITING_ACCOUNT_OWNER_VALIDATION, AWAITING_ENROLLMENT, AWAITING_DEVICE_REGISTRATION, PENDING_REVOKE, AUTHORIZED, REVOKED, REJECTED]

Enrollment status.

name string

Enrollment name.

logged_user_document stringrequired

Client logged user document.

logged_user_document_type stringrequired

Possible values: [CPF, CNPJ]

Client logged user document type.

logged_business_entity_document string

Client logged business entity document.

logged_business_entity_document_type string

Possible values: [CPF, CNPJ]

Client logged business entity document type.

permissions string[]required

Possible values: [PAYMENTS_INITIATE, RECURRING_PAYMENTS_INITIATE]

Enrollment permissions.

logged_user_bank_ispb string

Client logged user bank ISPB.

logged_user_branch_number string

Client logged user branch number.

logged_user_account_number string

Client logged user account number.

logged_user_account_type string

Possible values: [CACC, CASH, CHAR, CISH, COMM, CPAC, LLSV, LOAN, MGLD, MOMA, NREX, ODFT, ONDP, OTHR, SACC, SLRY, SVGS, TAXE, TRAN, TRAS, CC, PG, CD, CG, CI, PP, PI]

Client logged user account type.

transaction_limit number

Enrollment transaction limit.

daily_limit number

Enrollment daily limit.

expiration_date date-time

Enrollment expiration date.

participant_id stringrequired

Open Finance participant id.

participant_friendly_name stringrequired

Open Finance participant friendly name.

participant_friendly_logo_uri string

Open Finance participant friendly logo URI.

is_linked boolean

Enrollment is linked to an optimized journey.

link_id string

Enrollment link id to an optimized journey. Required if is_linked is true.

canceled_by_document string

Enrollment canceled by document.

canceled_by_document_type string

Possible values: [CPF, CNPJ]

Enrollment canceled by document type.

cancel_reason string

Possible values: [REJECTED_BY_DIFFERENT_ACCOUNT_HOLDER, REJECTED_BY_EXPIRED_RISK_SIGNALS, REJECTED_BY_EXPIRED_ACCOUNT_HOLDER_VALIDATION, REJECTED_BY_EXPIRED_ENROLLMENT, REJECTED_BY_MAXIMUM_CHALLENGES_REACHED, REJECTED_MANUALLY, REJECTED_BY_INCOMPATIBLE_DEVICE, REJECTED_BY_INFRASTRUCTURE_FAILURE, REJECTED_BY_HYBRID_FLOW_FAILURE, REJECTED_BY_FIDO_FAILURE, REJECTED_BY_INTERNAL_SECURITY, REJECTED_BY_OTHER_REASON, REVOKED_MANUALLY, REVOKED_BY_EXPIRED_VALIDITY, REVOKED_BY_INFRASTRUCTURE_FAILURE, REVOKED_BY_INTERNAL_SECURITY, REVOKED_BY_OTHER_REASON]

Enrollment canceled reason.

cancel_description string

Enrollment canceled description.

canceled_from string

Possible values: [INITIATOR, HOLDER]

Enrollment canceled from.

canceled_at date-time

Enrollment canceled at.

redirect_uri string

Enrollment redirect link.

created_at date-timerequired

Enrollment created at.

updated_at date-timerequired

Enrollment updated at.