Create sandbox task
curl --request POST \
--url https://platform.swipelux.com/v3/sandbox/tasks \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"scope": {
"type": "customer",
"customerId": "<string>"
},
"items": [
{
"request": "<string>",
"profilePointer": "<string>",
"constraints": {
"acceptedDocumentTypes": [
"<string>"
],
"maxAgeDays": 2,
"captureMethods": [
"<string>"
],
"nameMatch": "<string>",
"acceptedFormats": [
"<string>"
]
}
}
],
"dueAt": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://platform.swipelux.com/v3/sandbox/tasks"
payload = {
"scope": {
"type": "customer",
"customerId": "<string>"
},
"items": [
{
"request": "<string>",
"profilePointer": "<string>",
"constraints": {
"acceptedDocumentTypes": ["<string>"],
"maxAgeDays": 2,
"captureMethods": ["<string>"],
"nameMatch": "<string>",
"acceptedFormats": ["<string>"]
}
}
],
"dueAt": "2023-11-07T05:31:56Z"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
scope: {type: 'customer', customerId: '<string>'},
items: [
{
request: '<string>',
profilePointer: '<string>',
constraints: {
acceptedDocumentTypes: ['<string>'],
maxAgeDays: 2,
captureMethods: ['<string>'],
nameMatch: '<string>',
acceptedFormats: ['<string>']
}
}
],
dueAt: '2023-11-07T05:31:56Z'
})
};
fetch('https://platform.swipelux.com/v3/sandbox/tasks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://platform.swipelux.com/v3/sandbox/tasks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'scope' => [
'type' => 'customer',
'customerId' => '<string>'
],
'items' => [
[
'request' => '<string>',
'profilePointer' => '<string>',
'constraints' => [
'acceptedDocumentTypes' => [
'<string>'
],
'maxAgeDays' => 2,
'captureMethods' => [
'<string>'
],
'nameMatch' => '<string>',
'acceptedFormats' => [
'<string>'
]
]
]
],
'dueAt' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.swipelux.com/v3/sandbox/tasks"
payload := strings.NewReader("{\n \"scope\": {\n \"type\": \"customer\",\n \"customerId\": \"<string>\"\n },\n \"items\": [\n {\n \"request\": \"<string>\",\n \"profilePointer\": \"<string>\",\n \"constraints\": {\n \"acceptedDocumentTypes\": [\n \"<string>\"\n ],\n \"maxAgeDays\": 2,\n \"captureMethods\": [\n \"<string>\"\n ],\n \"nameMatch\": \"<string>\",\n \"acceptedFormats\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"dueAt\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://platform.swipelux.com/v3/sandbox/tasks")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"scope\": {\n \"type\": \"customer\",\n \"customerId\": \"<string>\"\n },\n \"items\": [\n {\n \"request\": \"<string>\",\n \"profilePointer\": \"<string>\",\n \"constraints\": {\n \"acceptedDocumentTypes\": [\n \"<string>\"\n ],\n \"maxAgeDays\": 2,\n \"captureMethods\": [\n \"<string>\"\n ],\n \"nameMatch\": \"<string>\",\n \"acceptedFormats\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"dueAt\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.swipelux.com/v3/sandbox/tasks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scope\": {\n \"type\": \"customer\",\n \"customerId\": \"<string>\"\n },\n \"items\": [\n {\n \"request\": \"<string>\",\n \"profilePointer\": \"<string>\",\n \"constraints\": {\n \"acceptedDocumentTypes\": [\n \"<string>\"\n ],\n \"maxAgeDays\": 2,\n \"captureMethods\": [\n \"<string>\"\n ],\n \"nameMatch\": \"<string>\",\n \"acceptedFormats\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"dueAt\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"customerId": "<string>",
"scope": {
"type": "<string>",
"id": "<string>"
},
"subject": {
"type": "<string>",
"id": "<string>"
},
"category": "<string>",
"revision": 2,
"remediationRound": 1,
"reason": {
"code": "<string>",
"message": "<string>",
"requestedBy": "<string>"
},
"dueAt": "2023-11-07T05:31:56Z",
"deadline": {
"at": "2023-11-07T05:31:56Z",
"noticeCount": 1
},
"notices": [
{
"at": "2023-11-07T05:31:56Z",
"type": "<string>",
"noticeCount": 1
}
],
"requirements": [
{
"id": "<string>",
"key": "<string>",
"request": {
"type": "profile",
"prompt": "<string>",
"required": true,
"profilePointer": "<string>",
"allowsAbsence": true,
"constraints": {
"minLength": 1,
"maxLength": 2,
"pattern": "<string>"
}
},
"section": "<string>",
"reviewFeedback": {
"code": "<string>",
"message": "<string>"
}
}
],
"completionPolicy": {
"completion": "all"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"verificationSessions": [
{
"id": "<string>",
"key": "<string>",
"type": "<string>"
}
],
"tosSessions": [
{
"id": "<string>",
"key": "<string>",
"type": "<string>"
}
],
"originGroupId": "<string>"
}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"correlationId": "<string>",
"transferId": "<string>",
"retryable": true,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"statusReason": {
"code": "sanctions_screening_failed",
"message": "<string>",
"retryable": true
},
"reviewAnswer": "<string>",
"capabilities": [
"<string>"
],
"blockingResources": [
{
"id": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"correlationId": "<string>",
"transferId": "<string>",
"retryable": true,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"statusReason": {
"code": "sanctions_screening_failed",
"message": "<string>",
"retryable": true
},
"reviewAnswer": "<string>",
"capabilities": [
"<string>"
],
"blockingResources": [
{
"id": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"correlationId": "<string>",
"transferId": "<string>",
"retryable": true,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"statusReason": {
"code": "sanctions_screening_failed",
"message": "<string>",
"retryable": true
},
"reviewAnswer": "<string>",
"capabilities": [
"<string>"
],
"blockingResources": [
{
"id": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"correlationId": "<string>",
"transferId": "<string>",
"retryable": true,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"statusReason": {
"code": "sanctions_screening_failed",
"message": "<string>",
"retryable": true
},
"reviewAnswer": "<string>",
"capabilities": [
"<string>"
],
"blockingResources": [
{
"id": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"correlationId": "<string>",
"transferId": "<string>",
"retryable": true,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"statusReason": {
"code": "sanctions_screening_failed",
"message": "<string>",
"retryable": true
},
"reviewAnswer": "<string>",
"capabilities": [
"<string>"
],
"blockingResources": [
{
"id": "<string>"
}
]
}sandbox
Create sandbox task
Creates a canonical sandbox task scoped to a customer, capability, or transfer.
Create sandbox task
curl --request POST \
--url https://platform.swipelux.com/v3/sandbox/tasks \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"scope": {
"type": "customer",
"customerId": "<string>"
},
"items": [
{
"request": "<string>",
"profilePointer": "<string>",
"constraints": {
"acceptedDocumentTypes": [
"<string>"
],
"maxAgeDays": 2,
"captureMethods": [
"<string>"
],
"nameMatch": "<string>",
"acceptedFormats": [
"<string>"
]
}
}
],
"dueAt": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://platform.swipelux.com/v3/sandbox/tasks"
payload = {
"scope": {
"type": "customer",
"customerId": "<string>"
},
"items": [
{
"request": "<string>",
"profilePointer": "<string>",
"constraints": {
"acceptedDocumentTypes": ["<string>"],
"maxAgeDays": 2,
"captureMethods": ["<string>"],
"nameMatch": "<string>",
"acceptedFormats": ["<string>"]
}
}
],
"dueAt": "2023-11-07T05:31:56Z"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
scope: {type: 'customer', customerId: '<string>'},
items: [
{
request: '<string>',
profilePointer: '<string>',
constraints: {
acceptedDocumentTypes: ['<string>'],
maxAgeDays: 2,
captureMethods: ['<string>'],
nameMatch: '<string>',
acceptedFormats: ['<string>']
}
}
],
dueAt: '2023-11-07T05:31:56Z'
})
};
fetch('https://platform.swipelux.com/v3/sandbox/tasks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://platform.swipelux.com/v3/sandbox/tasks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'scope' => [
'type' => 'customer',
'customerId' => '<string>'
],
'items' => [
[
'request' => '<string>',
'profilePointer' => '<string>',
'constraints' => [
'acceptedDocumentTypes' => [
'<string>'
],
'maxAgeDays' => 2,
'captureMethods' => [
'<string>'
],
'nameMatch' => '<string>',
'acceptedFormats' => [
'<string>'
]
]
]
],
'dueAt' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.swipelux.com/v3/sandbox/tasks"
payload := strings.NewReader("{\n \"scope\": {\n \"type\": \"customer\",\n \"customerId\": \"<string>\"\n },\n \"items\": [\n {\n \"request\": \"<string>\",\n \"profilePointer\": \"<string>\",\n \"constraints\": {\n \"acceptedDocumentTypes\": [\n \"<string>\"\n ],\n \"maxAgeDays\": 2,\n \"captureMethods\": [\n \"<string>\"\n ],\n \"nameMatch\": \"<string>\",\n \"acceptedFormats\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"dueAt\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://platform.swipelux.com/v3/sandbox/tasks")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"scope\": {\n \"type\": \"customer\",\n \"customerId\": \"<string>\"\n },\n \"items\": [\n {\n \"request\": \"<string>\",\n \"profilePointer\": \"<string>\",\n \"constraints\": {\n \"acceptedDocumentTypes\": [\n \"<string>\"\n ],\n \"maxAgeDays\": 2,\n \"captureMethods\": [\n \"<string>\"\n ],\n \"nameMatch\": \"<string>\",\n \"acceptedFormats\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"dueAt\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.swipelux.com/v3/sandbox/tasks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scope\": {\n \"type\": \"customer\",\n \"customerId\": \"<string>\"\n },\n \"items\": [\n {\n \"request\": \"<string>\",\n \"profilePointer\": \"<string>\",\n \"constraints\": {\n \"acceptedDocumentTypes\": [\n \"<string>\"\n ],\n \"maxAgeDays\": 2,\n \"captureMethods\": [\n \"<string>\"\n ],\n \"nameMatch\": \"<string>\",\n \"acceptedFormats\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"dueAt\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"customerId": "<string>",
"scope": {
"type": "<string>",
"id": "<string>"
},
"subject": {
"type": "<string>",
"id": "<string>"
},
"category": "<string>",
"revision": 2,
"remediationRound": 1,
"reason": {
"code": "<string>",
"message": "<string>",
"requestedBy": "<string>"
},
"dueAt": "2023-11-07T05:31:56Z",
"deadline": {
"at": "2023-11-07T05:31:56Z",
"noticeCount": 1
},
"notices": [
{
"at": "2023-11-07T05:31:56Z",
"type": "<string>",
"noticeCount": 1
}
],
"requirements": [
{
"id": "<string>",
"key": "<string>",
"request": {
"type": "profile",
"prompt": "<string>",
"required": true,
"profilePointer": "<string>",
"allowsAbsence": true,
"constraints": {
"minLength": 1,
"maxLength": 2,
"pattern": "<string>"
}
},
"section": "<string>",
"reviewFeedback": {
"code": "<string>",
"message": "<string>"
}
}
],
"completionPolicy": {
"completion": "all"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"verificationSessions": [
{
"id": "<string>",
"key": "<string>",
"type": "<string>"
}
],
"tosSessions": [
{
"id": "<string>",
"key": "<string>",
"type": "<string>"
}
],
"originGroupId": "<string>"
}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"correlationId": "<string>",
"transferId": "<string>",
"retryable": true,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"statusReason": {
"code": "sanctions_screening_failed",
"message": "<string>",
"retryable": true
},
"reviewAnswer": "<string>",
"capabilities": [
"<string>"
],
"blockingResources": [
{
"id": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"correlationId": "<string>",
"transferId": "<string>",
"retryable": true,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"statusReason": {
"code": "sanctions_screening_failed",
"message": "<string>",
"retryable": true
},
"reviewAnswer": "<string>",
"capabilities": [
"<string>"
],
"blockingResources": [
{
"id": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"correlationId": "<string>",
"transferId": "<string>",
"retryable": true,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"statusReason": {
"code": "sanctions_screening_failed",
"message": "<string>",
"retryable": true
},
"reviewAnswer": "<string>",
"capabilities": [
"<string>"
],
"blockingResources": [
{
"id": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"correlationId": "<string>",
"transferId": "<string>",
"retryable": true,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"statusReason": {
"code": "sanctions_screening_failed",
"message": "<string>",
"retryable": true
},
"reviewAnswer": "<string>",
"capabilities": [
"<string>"
],
"blockingResources": [
{
"id": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "<string>",
"detail": "<string>",
"correlationId": "<string>",
"transferId": "<string>",
"retryable": true,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"statusReason": {
"code": "sanctions_screening_failed",
"message": "<string>",
"retryable": true
},
"reviewAnswer": "<string>",
"capabilities": [
"<string>"
],
"blockingResources": [
{
"id": "<string>"
}
]
}Authorizations
Your Swipelux API key. Obtain this from the Swipelux Dashboard.
Body
application/json
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Minimum array length:
1Show child attributes
Show child attributes
Available options:
intake, information_request, correction_required, verification, terms_of_service, periodic_review, transaction_rfi, issue_resolution, other Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Sandbox task created
Show child attributes
Show child attributes
Related topics
Review sandbox task submissionCreate a task submissionSandboxQuickstartForce sandbox capability status⌘I