Connect Account
POST /accounts/connect
Submits an Account connection request with data provided by merchant (bypasses Connect Link).
The endpoint creates an Account object
Request Body
user_authorization
string
REQUIRED
The confirmation that an End User has authorized their account to be connected with the DRUO system. Must be true to be able to process account connection.
Possible values: TRUE FALSE
institution_uuid
string
REQUIRED
The UUID of the Institution where the Connected Account is registered.
Example value: ins_ff6c5094-1cd1-11ec-9621-0242ac130002
Check out list of Institutions here.
type
string
REQUIRED
The type of account. Determines whether account holds value.
Example value: DEPOSITORY
Check out list of Account Types here.
subtype
string
REQUIRED
The subtype of account. Provides further detail about the type of account.
Example value: SAVINGS
Check out list of Account Subtypes here.
account_number
integer
REQUIRED
The account’s number.
Example value: 400326054
new_end_user_details
EndUser
REQUIRED*
existing_end_user_id
string
The end user id
Example value: eur_ff6c5094-1cd1-11ec-9621-0242ac130002
routing_number
integer
The account’s routing number (usually indicates where the account was opened).
Example value: 324937448
primary_reference
string
The account primary reference. Can be any value to associate the connected account to an entity in an external system.
Example value: 23423524
secondary_reference
string
The account primary reference. Can be any value to associate the connected account to an entity in an external system.
Example value: bj39fhow39fhqp3f0hfae4344
metadata
string
Set of key-value pairs that you can attach to an object. You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long.
Example value: {"order_id": "6735"}
POST /accounts/connect
curl --location 'https://api.druo.com/accounts/connect' \
--header 'DRUO-Version: 2021-11-22' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ACCESS_TOKEN' \
--data-raw '{
"user_authorization": true,
"institution_uuid": "ins_9082d56c-4e1d-4967-a828-b7001755e88e",
"type": "DEPOSITORY",
"subtype": "SAVINGS",
"account_number": "1234567894",
"new_end_user_details": {
"type":"INDIVIDUAL",
"email": "j.doe@example.com",
"first_name": "John",
"last_name": "Doe",
"local_id": "123456789",
"local_id_type": "NATIONAL_IDENTITY_CARD",
"local_id_country": "USA"
}
}'
Response Fields
uuid
string
The Connected Account’s UUID.
Example value: acc_747536f4-1efd-4cad-91b3-cc8aaeed93e3
code
string
The Connected Account’s code.
Example value: ACSCDSVFGH
source_connect_link
string
The Connect Link used to connect this account.
Example value: clk_422f0f81-5001-4cce-a229-242d9ab9960a
current_status
string
The current status for this Connected Account.
Example value: CONNECTED
Check out the list of Account Connection Status here.
requires_account_validation
string
If this field is true, please use the Validate Account endpoint with the slug of pending_account_validations.
Example values: TRUE FALSE
Check out the Validate Account Endpoint documentation here.
pending_account_validations
object
Object that contains the list of pending account validations to connect this Account.
If this field is present, use the Validate Account endpoint with the slug value.
Example value:
[
{
"slug":"b8772a3a-ca25-4fec-a669-adb91d6ee26d-bc4277fa-3d5c-4383-bb50-f044975a66eb",
"action":"CONFIRM_REQUEST_WITH_INSTITUTION"
}
]
Check out the Validate Account Endpoint documentation here.
remarks
string
The account remarks for this Connected Account.
Example value: ACCOUNT_DOES_NOT_EXIST
institution
object
Object that contains the UUID of the Institution where the Connected Account is registered and the name of it.
Example value:
{
"uuid": "ins_ff6c5094-1cd1-11ec-9621-0242ac130002",
"name": "Banco"
}
last_4
string
The last 4 digits of the actual account number.
Example value: 4524
type
string
The type of account. Determines whether account holds value.
Example value: DEPOSITORY
Check out the list of Account Types here.
subtype
string
The subtype of account. Provides futher detail about the type of account.
Example value: SAVINGS
Check out the list of Account Subtypes here.
capabilities
string
The capabilities available for this account.
Example value: PAYMENTS, BALANCE, IDENTITY, AUTHENTICATION, TRANSFERS
end_user
EndUser
The full End User object related to this Account.
See more here.
disconnection_reason
string
The account’s disconnection reason.
Example value: ACTIVITY_COMPLETED
disconnection_note
string
The account’s disconnection note.
primary_reference
string
The account primary reference. Can be any value to associate the connected account to an entity in an external system.
Example value: 23423524
secondary_reference
string
The account primary reference. Can be any value to associate the connected account to an entity in an external system.
Example value: bj39fhow39fhqp3f0hfae4344
metadata
string
Set of key-value pairs that you can attach to an object. You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long.
Example value: {"order_id": "6735"}
creation_source
string
The creation source for this account.
Example value: MERCHANT_API
date_created_gmt
date-time
Create date of the account
Example value: 2021-11-15T23:23:38Z
date_updated_gmt
date-time
Updated date of the account
Example value: 2021-11-15T23:23:38Z
Response
{
"account": {
"uuid": "acc_5692ada9-1c6e-4297-94fc-733c95a08344",
"code": "AWWV24FTK9R",
"source_connect_link": null,
"current_status": "CREATED",
"requires_account_validation": false,
"pending_account_validations": null,
"remarks": null,
"institution": {
"uuid": "ins_9082d56c-4e1d-4967-a828-b7001755e88e",
"name": "Davivienda"
},
"last_4": "7894",
"type": "DEPOSITORY",
"subtype": "SAVINGS",
"capabilities": [],
"end_user": {
"uuid": "eur_868d99a5-6578-40cf-8aec-e7a48085fa37",
"code": "EUJXRKMEPER",
"type": "INDIVIDUAL",
"first_name": "John",
"last_name": "Doe",
"organization": null,
"local_id": "987654321",
"local_id_type": "DRIVERS_LICENSE",
"local_id_country": "USA",
"date_of_birth": null,
"email": "john.doe@example.com",
"phone_number": null,
"address": null,
"preferred_language": "en_US",
"note": null,
"primary_reference": null,
"secondary_reference": null,
"metadata": {},
"creation_source": "MERCHANT_API",
"date_created_gmt": "2023-09-29T02:48:41.388Z",
"date_updated_gmt": "2023-09-29T02:54:32.974Z"
},
"disconnection_reason": null,
"disconnection_note": null,
"primary_reference": null,
"secondary_reference": null,
"metadata": {},
"creation_source": "MERCHANT_API",
"date_created_gmt": "2023-09-29T02:54:32.974Z",
"date_updated_gmt": "2023-09-29T02:54:32.974Z"
}
}