Create Shareable Sign-up Link
Generate a reusable or one-time link that a partner can manually share for sign-up. The merchant can then click on the link and open an invitation to join the Partner Portal. The merchant's account will be linked to your account.
offering_id
Identifier of the offering to associate with the sign-up link. String starting with _offering.
partner_user
Object containing partner user details.
type
Type of sign-up link. Valid values: limited, unlimited.
usage_limit
Maximum number of times the link can be used. Required when
typeis limited. Must be ≥ 1.
created_at
Time of creation of the link, 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
Ready-to-use URL of the sharable sign-up link. The partner can copy-paste this link into WhatsApp, SMS, or a CRM. No email is sent.
offering_id
Identifier of the offering associated with the link. String starting with _offering.
offering_name
Name of the offering associated with the link.
partner_name
Name of the partner.
status
Status of the sign-up link. Valid values: ACT (active), 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 so far.
usage_limit
Maximum number of times the link can be used.
{base_uri}/partner/onboarding/sign_up_links
Create Sharable Signup Link
curl -X POST {base_uri}/partner/onboarding/sign_up_links -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' \ --data-raw ' { "partner_user": { "email": "user@example.com" }, "type": "limited", "offering_id": "offering_7a4e05312b88f2c311cb7e7f5e152571", "usage_limit": "1" } '{ "status": { "error_code": "", "status": "SUCCESS", "message": "Success", "response_code": "", "operation_id": "2221b9a5-5467-4353-b83e-c5f5918af7de" }, "data": { "link_url": "https://dashboard.rapyd.net/branded-sign-up/partner/26c64f3b9cc8068cb131aace1f94d7762e7f6b8e9bed3", "status": "ACT", "partner_name": "Example Partner", "offering_name": "offering_payment2", "created_by": "Example User", "created_at": 1779262604, "updated_at": 1779262604, "usage_limit": 1, "usage_count": 0, "expired_at": null, "type": "limited", "id": "26c64f3b9cc8068cb131aace1f94d7762e7f6b8e9bed3", "offering_id": "offering_7a4e05312b88f2c311cb7e7f5e152571" } }