Create Invitation

POST

/public/v3/invitations

Creates a new Invitation.

Invitations are special links for the customer that you can send to request their bank account data.

Please create a Customer before using this endpoint. Invitations are automatically assigned to customers by reference.

Before using this endpoint, please create a customer with a reference and then use this reference in this endpoint. Invitations are automatically assigned to the customer by a reference, so ensure it is the same. You can generate infinite invitations; it can be helpful to ask for more bank account data. Invitations can be sent by Planky via email. To make it happen, use the send_email flag set to true. If you just want a pure URL, set send_email to false.

Once the customer shares their bank account data, you can listen to Webhooks (REPORT_AVAILABLE and REPORT_UPDATED) to pull data into your system.

Parameters

none

Query parameters

none

Request body parameters

Parameter	Data type	Required?	Description
customer_type	enum	no	Allowed:(Individual, Business)
last_name	string	no	Last name
first_name	string	no	First name
company_name	string	no	Company name
email	string	yes	Email
phone	string	no	Phone
reference	string	yes	Customer reference
send_email	boolean	no	Set to true if you want Planky to send email with invitation

Response body parameters

Parameter	Data type	Required?	Description
id	string	yes	ID
customer_type	enum	yes	Allowed:(Individual, Business)
last_name	string	yes	Last name
first_name	string	yes	First name
company_name	string	yes	Company name
email	string	yes	Email
phone	string	yes	Phone
reference	string	yes	Customer reference
send_email	boolean	yes	Set to true if you want Planky to send email with invitation
created_at	integer	yes	When the invitation was created
revoked_at	integer	no	When the invitation was revoked
used_at	integer	no	When the invitation was used
expires_in	integer	yes	Expires in [s] seconds.
url	string	yes	URL shared with your customer

Request example

curl --location --request POST 'https://api.friendlyscore.com/public/v3/invitations' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}' \
--data-raw '{
  "customer_type": "Individual",
  "last_name": "John",
  "first_name": "Doe",
  "company_name": "Example INC.",
  "email": "john.doe@example.com",
  "phone": "+44123456789",
  "reference": "123-123-123",
  "send_email": false
}'

Response example:

 {
    "id": "123",
    "customer_type": "Individual",
    "last_name": "John",
    "first_name": "Doe",
    "company_name": "Example INC.",
    "email": "john.doe@example.com",
    "phone": "+44123456789",
    "reference": "123-123-123",
    "send_email": false,
    "created_at": 1701425459,
    "revoked_at": null,
    "used_at": null,
    "expires_in": 2592000,
    "url": "https://planky.com/invitation/XYZ"
}

Was this article helpful?

Friendly Score UK Ltd.

84 Brook Street

London W1K 5EH

Call us on +44 20 3709 6726

Company registered in England

Company number 09168668, ICO ZA111687

VAT registration number 206 9758 80

Authorised and Regulated by the Financial Conduct Authority. (FRN: 821100, 781963)