User invites

User invites represent the invitations sent to a user's email or phone.

While it is possible to invite users via the Argyle Console, you can also utilize the Argyle API to invite users programmatically via email and/or text message.

The invite template consists of three components:

  • Text message
  • Email
  • Landing page

You can invite a user via text message, email, or both. When a user clicks on the call-to-action link in the text message or button in the email, they are directed to a dedicated landing page. The user's information is captured in the user invite object.

You can customize parts of the text message, email, and landing page by utilizing the /user-invite-templates endpoint. User invite data is stored in the user invite object.

User invite template

Attributes

Attribute

Type

Description

id

string uuid

A unique ID for the template.

name

string

The name of the template.

company

string

Your company/brand name that is shown to users in the invite.

logo_url

string

A link to the logo to be used in the invitation email. Logo dimensions: 120x120 px.

sms_body

string

The text message content to be sent as part of the invitation.

sender

string

The "From" field of the invitation email.

subject

string

The email subject of the invitation email.

header

string

The title header of the invitation email.

email_body

string

The text content of the invitation email.

button

string

The call-to-action button label within the email.

page_heading

string

The heading 1 of the landing page.

page_description

string

The text content of the landing page.

page_button

string

The call-to-action button label on the landing page to initiate Argyle Link.

page_config

object
See underlying attributes

Configuration parameters for the success page.

reply_to

string optional

The reply email address for your user invite.

Attributes of page_config

Attribute

Type

Description

page_success_heading

string required

The heading 1 of the success page.

page_success_description

string required

The text content of the success page.

page_success_show_button

boolean required

Denotes if the action button on the success page is shown.

If set to true, a value for page_success_button is required.

page_success_button

string

The call-to-action button label on the success page.

It is required when page_success_show_button is set to true.

Endpoints

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

Attribute

Type

Description

id

string uuid

A unique ID for the invite.

user

string uuid

The user ID associated with this invite. It is available only when a user has accepted the invite and successfully connected via Argyle Link.

accepted_invitation

boolean

Denotes whether the invite has been accepted by connecting via Argyle Link and status becomes connected.

Possible values: true, false.

user_token

string uuid

A 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_name

string

The full name of the user.

email

string

The email address which received the invite.

phone_number

string

The phone number which received the invite.

invited_at

string

Denotes 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_id

string uuid

ID of the user invite template that was used to send the invite.

status

string

The status of the invitation.

Possible values: connected, invited, revoked.

revoked_at

string

Denotes when the invite was revoked. Timestamps follow the ISO 8601 standard.

Endpoints

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 set pay distribution configurations with the invite?

Yes, you can pass the pay distribution configurations when you send the invite.