User invites

Learn about the /user-invite-templates and /user-invites endpoints.

You can send invites to new users containing a link they can click to connect their payroll accounts through Argyle. Invites can be sent via Console or using the API method below.

User invites are created using the /user-invite-templates endpoint and sent using the /user-invites endpoint.

User invites can be sent via SMS, email, or both.

  • Both SMS and email fields must be included in user invite templates
  • You can choose whether to send an SMS, email, or both when sending an invite

Creating an invite template will generate a unique id which can be used as the invite-template-id when sending an invite. This invite-template-id contains your messaging and landing page customizations.

Once an invite is sent, a user invite object will be created.

User invite template

Attributes

AttributeTypeDescription
idstring uuidA unique ID for the template.
namestringThe name of the template.
companystringYour company/brand name that is shown to users in the invite.
logo_urlstringA link to the logo to be used in the invitation email. Logo dimensions: 120x120 px.
sms_bodystringThe text message content to be sent as part of the invitation.

senderstringThe "From" field of the invitation email.

subjectstringThe email subject of the invitation email.
headerstringThe title header of the invitation email.
email_bodystringThe text content of the invitation email.
buttonstringThe call-to-action button label within the email.
page_headingstringThe heading 1 of the landing page.

page_descriptionstringThe text content of the landing page.
page_buttonstringThe call-to-action button label on the landing page to initiate Argyle Link.
page_configobject
See underlying attributes
Configuration parameters for the success page.
reply_tostring optionalThe reply email address for your user invite.

Attributes of page_config

AttributeTypeDescription
page_success_headingstring requiredThe heading 1 of the success page.
page_success_descriptionstring requiredThe text content of the success page.
page_success_show_buttonboolean requiredDenotes if the action button on the success page is shown.

If set to true, a value for page_success_button is required.
page_success_buttonstringThe call-to-action button label on the success page.

It is required when page_success_show_button is set to true.

Endpoints

These are the endpoints available for user-invite-templates.

Example object

{
    "id": "9f82994c-774d-11eb-b1c7-13e87316bacb",
    "name": "regular",
    "company": "GoodLoans",
    "logo_url": "https://company.com/logo.jpg",
    "sms_body": "[Company] has asked you to connect your employment account. Get started here: [Link]",
    "sender": "[Company]",
    "subject": "Connect Your Employment Account",
    "header": "[Company] is requesting you to connect your employment account",
    "email_body": "Hi, [Name]\n\n[Company] is working with a 3rd party to verify your work history. It’s a quick process that should not take longer than a few minutes to complete. Get started by clicking the link below.\n\nSincerely,\n[Sender]",
    "button": "Connect your employment account",
    "page_heading": "Let's connect your employment account",
    "page_description": "[Company] has asked you to connect your employment account to use their services.",
    "page_button": "Connect Account",
    "page_config": {
        "page_success_heading": "Thank you for connecting your accounts",
        "page_success_description": "You are all set. If you have any questions please reach out to [Company]",
        "page_success_button": "Connect Account",
        "page_success_show_button": true
    }
}

User invite object

Attributes

AttributeTypeDescription
idstring uuidA unique ID for the invite.
userstring uuidThe user ID associated with this invite. It is available only when a user has accepted the invite and successfully connected via Argyle Link.
accepted_invitationbooleanDenotes whether the invite has been accepted by connecting via Argyle Link and status becomes connected.

Possible values: true, false.
user_tokenstring uuidA unique token generated by Argyle Link. Only available when a user has attempted to connect via Argyle Link. Used to restore the session when the user comes back for a second time to update their information.
full_namestringThe full name of the user.
emailstringThe email address which received the invite.
phone_numberstringThe phone number which received the invite.
invited_atstringDenotes the time when the invitation was sent out. This field is updated if you resend an invite. Timestamps follow the ISO 8601 standard.
invite_template_idstring uuidID of the user invite template that was used to send the invite.
statusstringThe status of the invitation.

Possible values: connected, invited, revoked.
revoked_atstringDenotes when the invite was revoked. Timestamps follow the ISO 8601 standard.

Endpoints

These are the endpoints available for user-invites.

Endpoints
Send an invite - POST /user-invites
Resend an invite - POST /user-invites/:id
Revoke an invite - POST /user-invites/:id/revoke
Retrieve an invite - GET /user-invites/:id
List invites - GET /user-invites
Create an invite template - POST /user-invite-templates
Retrieve a template - GET /user-invite-templates/:id
List templates - GET /user-invite-templates
Delete a template - DELETE /user-invite-templates/:id

Example object

{
    "id": "317e7736-7761-11eb-b642-238b63a89ff2",
    "user": "8a5f613a-673a-4434-aeee-1a38b960b936",
    "accepted_invitation": true,
    "user_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjE2ODQ3MzA1LCJqdGkiOiI1NzA2ZjM5MTEzMzk0ZDM1YTA5MWVjYzgxNjc3NjdjNCIsInVzZXJfaWQiOiI4YTVmNjEzYS02NzNhLTQ0MzQtYWVlZS0xYTM4Yjk2MGI5MzYiLCJjbGllbnRfaWQiOiJjMDIwYjNjMy0zY2Q5LTRmY2YtYjg1OC0xMzlkZWU2NmU2ZjMifQ.9CzhA-Gx9QqBManrogEbgHuKduVWvtC9OGxDe_RTgl8",
    "email": "[email protected]",
    "phone_number": "+12025550104",
    "full_name": "John Smith",
    "invited_at": "2021-02-25T12:01:29.083Z",
    "invite_template_id": "315e0d98-7761-11eb-b642-c7dfaaf3c8cf",
    "revoked_at": null,
    "status": "connected"
}

FAQ

Can I use the invite for returning users?

No, the invites are designed specifically for new users.

How can I track if the invited user was connected?

When you create the user invite, it returns a payload with a User ID. You can use that User ID to track if this user has actually connected.

The accounts.added webhook also returns the User ID, which can be utilized to confirm if the user has successfully created an account.

📘

It is also advisable to utilize the /user-token endpoint at this stage in order to create a returning user experience on your end.

Is it possible to add a direct deposit switching flow to the invite?

Yes, you can pass your encrypted payDistributionConfig in the pd_config body parameter when sending the invite.