Skip to main content

Documentación

List Sign-Up Links

Retrieve a list of sign-up links generated by the partner, including usage data and status information for each link.

    • created_after

    • Filter links created after this time, in Unix time.

    • created_before

    • Filter links created before this time, in Unix time.

    • limit

    • Maximum number of results to return.

    • offering_id

    • Filter by offering identifier.

An array of objects where each object includes the following parameters:

    • created_at

    • Time the link was created, in Unix time.

    • created_by

    • Name of the user who created the link.

    • expired_at

    • Expiration time of the link, in Unix time. null if no expiration is set.

    • id

    • Unique identifier of the sign-up link.

    • link_url

    • URL of the sign-up link.

    • offering_id

    • Identifier of the associated offering. string Starting with offering_.

    • offering_name

    • Name of the offering associated with the link.

    • status

    • Status of the sign-up link. Valid values: : ACT (active) and EXP (expired).

    • type

    • Type of the sign-up link. Valid values: limited, unlimited.

    • updated_at

    • Time the link was last updated, in Unix time.

    • usage_count

    • Number of times the link has been used.

    • usage_limit

    • Maximum number of times the link can be used.

  • {base_uri}/partner/onboarding/sign_up_links

  • List Sign-Up Links

  • curl -X GET
    '{base_uri}/partner/onboarding/sign_up_links?limit=2&offering_id=offering_7a4e05312b88f2c311cb7e7f5e152571'
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -H 'merchant_account_id: your-merchant-account-here' \
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "Success",
            "response_code": "",
            "operation_id": "29f1b663-ab02-4245-b7c3-fe728578564e"
        },
        "data": [
            {
                "link_url": "https://dashboard.rapyd.net/branded-sign-up/partner/26c64f3b9cc8068cb131aace1f94d7762e7f6b8e9bed3",
                "status": "ACT",
                "offering_name": "Example Offering",
                "created_by": "Example User",
                "usage_limit": 1,
                "usage_count": 0,
                "expired_at": null,
                "type": "limited",
                "id": "26c64f3b9cc8068cb131aace1f94d7762e7f6b8e9bed3",
                "offering_id": "offering_7a4e05312b88f2c311cb7e7f5e152571",
                "created_at": 1779262604,
                "updated_at": 1779262604
            },
            {
                "link_url": "https://dashboard.rapyd.net/branded-sign-up/partner/a564218eda8f854ae26272f64aadb80a761641179e0ba",
                "status": "ACT",
                "offering_name": "Example Offering",
                "created_by": "Example User",
                "usage_limit": 1,
                "usage_count": 0,
                "expired_at": null,
                "type": "limited",
                "id": "a564218eda8f854ae26272f64aadb80a761641179e0ba",
                "offering_id": "offering_7a4e05312b88f2c311cb7e7f5e152571",
                "created_at": 1779196614,
                "updated_at": 1779196614
            }
        ]
    }