curl --request POST \
--url https://sandbox-platform.jupico.com/v1/query/onboardinginvites \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://sandbox-platform.jupico.com/v1/query/onboardinginvites"
payload = {}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://sandbox-platform.jupico.com/v1/query/onboardinginvites', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/query/onboardinginvites';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"count": 123,
"data": [
{
"spProductId": "<string>",
"inviteId": "<string>",
"name": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"reference": "<string>",
"url": "<string>",
"notifications": {
"email": {
"enabled": true,
"sent": true
},
"sms": {
"enabled": true,
"sent": true
}
},
"status": "<string>",
"feesTemplateId": "<string>",
"onboardingFlowTemplateId": "",
"expiresAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"query": {
"criteria": {},
"options": {}
}
}List onboarding invites
Returns onboarding invites and their current status — created, sent, completed, or cancelled.
curl --request POST \
--url https://sandbox-platform.jupico.com/v1/query/onboardinginvites \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://sandbox-platform.jupico.com/v1/query/onboardinginvites"
payload = {}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://sandbox-platform.jupico.com/v1/query/onboardinginvites', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/query/onboardinginvites';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"count": 123,
"data": [
{
"spProductId": "<string>",
"inviteId": "<string>",
"name": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"reference": "<string>",
"url": "<string>",
"notifications": {
"email": {
"enabled": true,
"sent": true
},
"sms": {
"enabled": true,
"sent": true
}
},
"status": "<string>",
"feesTemplateId": "<string>",
"onboardingFlowTemplateId": "",
"expiresAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"query": {
"criteria": {},
"options": {}
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
The body is of type object.
Response
Find Onboarding invites
Whether the request was processed successfully. Declines return HTTP 200 with success: false.
Number of records.
The response payload.
Hide child attributes
Hide child attributes
Identifier of the Service Provider product the merchant belongs to.
Unique identifier of the onboarding invite.
Display name.
Email address.
Phone number.
Your own reference for this invite.
URL of the hosted page for this object.
Delivery status of invite notifications.
Hide child attributes
Hide child attributes
Current status.
UUID of a fees template with predefined pricing. If omitted, the default template is used.
UUID of the onboarding flow template that controls which steps the merchant sees.
""
Timestamp when this object expires (ISO 8601).
Timestamp when the object was created (ISO 8601).
Timestamp when the object was last updated (ISO 8601).
Was this page helpful?

