Skip to main content

Create Open Finance Device Enrollment

POST 
/open-finance/enrollments/:enrollment_id/device/:id

Create a new Open Finance device enrollment. Must be called after the device permission is created.

Request​

Path Parameters

    enrollment_id stringrequired

    Enrollment id.

    id stringrequired

    Device enrollment id.

Header Parameters

    x-include-replay-protection-schema string

    The replay-protection-schema allows the user to choose between 3 options:

    • If there's no value: The default protection checks that the values in this request are equal: { method, params, path, query, body, userId }. This means that if a request repeats the same values, it will be blocked.
    • 'nonce': The nonce and { method, params, path, query, body, userId } value are checked. When the protection schema is this, requests will be OK if this nonce value is different in each request.
    • 'x-transaction-uuid': The transactionId and { method, params, path, query, body, userId } value are checked. Requests will be OK if this x-transaction-uuid value is different in each request.
    • 'x-transaction-uuid&nonce' or 'nonce&x-transaction-uuid': The nonce, transactionId value and { method, params, path, query, body, userId } are checked, i.e. if requests are repeated the same value in both fields, they will be blocked. But if any field has a different value, the request is OK.

    x-wallet-uuid string

    Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-product-uuid string

    UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

    x-product-target-user-uuid string

    UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

Body

required
    device_credential_id stringrequired

    Includes information about the application that generated the credential. Must be sent to the holder in base64 format.

    device_credential_raw_id stringrequired

    Device credential raw ID. Must match the device_credential_id property.

    device_credential_client_data_json stringrequired

    Information about the APP that generated the credential. Must be a base64url encoded string.

    device_credential_attestation_object stringrequired

    Information about the public key of the credential. Must be a base64url encoded string.

    device_credential_authenticator_attachment string

    Device credential authenticator attachment.

    device_credential_type string

    Device credential type.

    client_extension_results object

    Client extension results.

Responses​

The device enrollment created. Successfully!.

Schema
    id stringrequired

    Device enrollment id.

    enrollment_id stringrequired

    Enrollment id.

    status stringrequired

    Possible values: [WAITING_RISK_SIGNAL, WAITING_CREDENTIALS_CREATION, WAITING_CREATION, WAITING_SIGN_IN, SIGNED_IN, CREATED, ERROR, FAILED]

    Device enrollment status.

    created_at date-timerequired

    Device enrollment created at.

Loading...