Skip to main content
Connect API

List Connect Link

GET /connect/link/list/

Returns the details of an existing Connect Link.
This list uses pagination.

Available Filters

This endpoint supports advanced filtering and search capabilities based on the parameters below.
The parameters should be appended to the API URL as follows:

 https://api.druo.com/connect/link/list?uuid=cnl_1231-123123-123123-1234&end_user_email=j.smith@example.com.
Category Query Parameter Description
General delivery_status The connect link's delivery status.
General code The connect link's code.
General uuid The connect link's uuid.
General primary_reference The end of creation date range in GMT time.
General secondary_reference Any value contained within the secondary reference.
General date_from The beginning of the creation date range in GMT time.
General date_to The end of creation date range in GMT time.
End User end_user_uuid Any connect link with an end user uuid
End User end_user_code Any connect link with an end user code
End User end_user_email Any connect link with an end user email
End User end_user_local_id Any connect link with an end user local id

Response Fields

uuid

string

The Connect Link’s UUID.

Example value:  clk_aee571f2-cdf0-4fad-8abb-74fcb8b83f20

code

string

The Connect Link’s code.

Example value:  CLR33JXMNXU

url

string

The URL that the user should be sent to to connect their account.

Example value:  https://link.druo.com/connect/secure?sl=fd6f7577c

expired

string

If true, the link is expired.

Example value:  FALSE

background_color

string

The HEX code for the link’s background color.

Example value:  #333333

button_color

string

The HEX code for the link’s button color.

Example value:  #ffffff

button_text_color

string

The HEX code for the link’s button text color.

Example value:  #000000

content_box_text_color

string

The HEX code for the content box text color.

Example value:  #333333

content_background_color

string

The HEX code for the content background text color.

Example value:  #eaeaea

intro_text

 

string

The key-value pairs for the intro text for each language. The text in all of the options must include the merchant name (as registered in the business profile) as well as the text “DRUO”.

Example value:

en_US: NOVO uses DRUO to connect to your bank account.
es_CO: NOVO utiliza a DRUO para conectarse con tu cuenta bancaria.

delivery_status

string

The connect link’s delivery status.

Example value:  CREATED

end_user

EndUser

Customer Information.

See more here.

default_institution

string

The connect link’s default institution.

primary_reference

 

string

The connect link’s 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 connect link’s primary reference. Can be any value to associate the connected account to an entity in an external system.
Example value:  bj39fhow39fhqp3f0hfae4344

default_language

string

The language code to display this link in. If left blank, system will default to English.

Possible values:  es_CO, en_US

redirect_url

string

The URL to redirect to after the connection flow is completed. Reference, Status, and Connected Account Code will be appended as URL parameters. For example, if the provided redirect URL is http://www.example.com/order-complete, a successful transaction redirects the customer to: http://www.example.com/order-complete?code=CM9D3DOH39H&…

Example value:  https://example.com

expiration_date

string

The expiration date for this Connect Link in GMT time. If set, the user will be presented with an error upon open opening the link.

Example value:  2021-11-16T23:23:38

custom_confirmation_page

boolean

If true, the user will be taken directly to the redirect URL without showing the DRUO redirect page.

Example value:  FALSE

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"}

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
GET /connect/link/list
curl --location 'https://api.druo.com/connect/link/list' \
--header 'DRUO-Version: 2021-11-22' \
--header 'Authorization: Bearer ACCESS_TOKEN'
Response 
{
    "connect_links": [
        {
            "uuid": "clk_aee571f2-cdf0-4fad-8abb-74fcb8b83f20",
            "code": "CLR33JXMNXU",
            "url": "https://link.druo.com/connect/secure?sl=fd6f7577-2a44-4d6d-b5b1-5e5722fb6db9-02bfc593-ed6b-4a79-b5a2-d33c9f7caa5b",
            "expired": false,
            "background_color": null,
            "button_color": null,
            "button_text_color": null,
            "content_box_text_color": null,
            "content_background_color": null,
            "intro_text": "Connect your account using DRUO to receive or make payments",
            "delivery_status": "CREATED",
            "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": {},
                "date_created_gmt": "2023-09-29T02:48:41.388Z",
                "date_updated_gmt": "2023-10-08T03:19:32.588Z"
            },
            "default_institution": null,
            "primary_reference": null,
            "secondary_reference": null,
            "default_language": "en_US",
            "redirect_url": null,
            "expiration_date": "2023-10-14T03:32:21.198Z",
            "custom_confirmation_page": false,
            "metadata": {},
            "date_created_gmt": "2023-10-08T03:32:21.457Z",
            "date_updated_gmt": "2021-10-13T19:34:34.456Z"
        }
    ],
    "page_info": {
        "has_next_page": true,
        "page_size": 1
    }
}
Close Menu