Sign in

v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-27107348584.3 KB
Invite Templates

Create Invite Template

Create an invite template.

post/inviteTemplates

Request body

namestring required

Template name

Example request

{
  "name": "Email Template v1",
  "company": {
    "name": "XYZ Bank",
    "logoUrl": "https://xyzbank.co/logo.png"
  },
  "email": {
    "senderName": "XYZ Bank",
    "replyAddress": "replies@xyz.co",
    "subject": "Please connect your work account to share your data with us",
    "body": "Hello ${firstName}, We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for giving you service. It will be a quick process and should take no more than a few seconds of your time."
  },
  "landingPage": {
    "header": "We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for giving you service. It will be a quick process and should take no more than a few seconds of your time.",
    "description": "Share your employment and income data with us at ${companyName}",
    "button": "START NOW"
  },
  "successPage": {
    "header": "The process was successful! Please wait for us to get in touch!",
    "description": "Thank you for sharing your employment and income data with us at ${companyName}",
    "button": "Connect another account"
  }
}

Response

OK

code'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED'

Request status code

messagestring

Message response to the request

requestIdstring

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

Example response

{
  "code": "OK",
  "message": "Success",
  "requestId": "5b79399a-6852-4234-bb0e-ad472648282d",
  "data": {
    "id": "17bbf36498de4d68a0d4f86c7b62f69f",
    "name": "Email Template v1",
    "company": {
      "name": "XYZ Bank",
      "logoUrl": "https://xyzbank.co/logo.png"
    },
    "email": {
      "senderName": "XYZ Bank",
      "replyAddress": "replies@xyz.co",
      "subject": "Please connect your work account to share your data with us",
      "body": "Hello ${firstName}! We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for giving you service. It will be a quick process and should take no more than a few seconds of your time."
    },
    "landingPage": {
      "header": "Share your employment and income data with us at ${companyName}",
      "description": "We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for giving you service. It will be a quick process and should take no more than a few seconds of your time.",
      "button": "START NOW"
    },
    "successPage": {
      "header": "Thank you for sharing your employment and income data with us at ${companyName}",
      "description": "The process was successful! Please wait for us to get in touch!",
      "button": "Connect another account"
    }
  }
}