Get customer task detail
curl --request GET \
--url https://platform.swipelux.com/v3/customers/{customerId}/tasks/{taskId} \
--header 'X-API-Key: <api-key>'import requests
url = "https://platform.swipelux.com/v3/customers/{customerId}/tasks/{taskId}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://platform.swipelux.com/v3/customers/{customerId}/tasks/{taskId}', 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/customers/{customerId}/tasks/{taskId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://platform.swipelux.com/v3/customers/{customerId}/tasks/{taskId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://platform.swipelux.com/v3/customers/{customerId}/tasks/{taskId}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.swipelux.com/v3/customers/{customerId}/tasks/{taskId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
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>",
"status": "action_required",
"revision": 2,
"remediationRound": 1,
"reason": {
"code": "<string>",
"message": "<string>",
"requestedBy": "<string>"
},
"dueAt": "2023-11-07T05:31:56Z",
"deadline": {
"at": "2023-11-07T05:31:56Z",
"outcome": "none",
"noticeCount": 1
},
"notices": [
{
"at": "2023-11-07T05:31:56Z",
"type": "<string>",
"noticeCount": 1
}
],
"requirements": [
{
"id": "<string>",
"key": "<string>",
"status": "action_required",
"request": {
"type": "profile",
"prompt": "<string>",
"required": true,
"valueType": "string",
"profilePointer": "<string>",
"allowsAbsence": true,
"itemValueType": "<string>",
"constraints": {
"minLength": 1,
"maxLength": 2,
"pattern": "<string>"
}
},
"section": "<string>",
"reviewFeedback": {
"code": "<string>",
"message": "<string>"
}
}
],
"allowedSubmissionChannels": [
"direct_submission"
],
"verificationSessions": [
{
"id": "<string>",
"key": "<string>",
"type": "<string>",
"status": "action_required",
"url": "<string>",
"expiresAt": null
}
],
"tosSessions": [
{
"id": "<string>",
"key": "<string>",
"type": "<string>",
"status": "action_required",
"url": "<string>",
"expiresAt": null
}
],
"completionPolicy": {
"type": "requirements",
"completion": "all"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"originGroupId": "<string>"
}
}{
"type": "https://docs.swipelux.com/errors/unknown-parameter",
"title": "<string>",
"status": 400,
"code": "unknown_parameter",
"detail": "<string>",
"correlationId": "<string>",
"retryable": false,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"type": "https://docs.swipelux.com/errors/unauthorized",
"title": "<string>",
"status": 401,
"code": "unauthorized",
"detail": "<string>",
"correlationId": "<string>",
"retryable": false,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"type": "https://docs.swipelux.com/errors/forbidden",
"title": "<string>",
"status": 403,
"code": "forbidden",
"detail": "<string>",
"correlationId": "<string>",
"retryable": false,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"type": "https://docs.swipelux.com/errors/task-not-found",
"title": "<string>",
"status": 404,
"code": "task_not_found",
"detail": "<string>",
"correlationId": "<string>",
"retryable": false,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"type": "https://docs.swipelux.com/errors/internal-error",
"title": "<string>",
"status": 500,
"code": "internal_error",
"detail": "<string>",
"correlationId": "<string>",
"retryable": true,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}Tasks
Get customer task detail
Returns the authorized task action surface with its immutable allowed submission channels in canonical direct_submission then verification_session order. Process KYC sessions expose exact customer/task/session first-party action URLs only while action is required; in-review, completed or reused, rejected, and canceled process sessions omit action fields. Process, execution, completion, reuse, and provider-configuration identities remain internal.
Get customer task detail
curl --request GET \
--url https://platform.swipelux.com/v3/customers/{customerId}/tasks/{taskId} \
--header 'X-API-Key: <api-key>'import requests
url = "https://platform.swipelux.com/v3/customers/{customerId}/tasks/{taskId}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://platform.swipelux.com/v3/customers/{customerId}/tasks/{taskId}', 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/customers/{customerId}/tasks/{taskId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://platform.swipelux.com/v3/customers/{customerId}/tasks/{taskId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://platform.swipelux.com/v3/customers/{customerId}/tasks/{taskId}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.swipelux.com/v3/customers/{customerId}/tasks/{taskId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
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>",
"status": "action_required",
"revision": 2,
"remediationRound": 1,
"reason": {
"code": "<string>",
"message": "<string>",
"requestedBy": "<string>"
},
"dueAt": "2023-11-07T05:31:56Z",
"deadline": {
"at": "2023-11-07T05:31:56Z",
"outcome": "none",
"noticeCount": 1
},
"notices": [
{
"at": "2023-11-07T05:31:56Z",
"type": "<string>",
"noticeCount": 1
}
],
"requirements": [
{
"id": "<string>",
"key": "<string>",
"status": "action_required",
"request": {
"type": "profile",
"prompt": "<string>",
"required": true,
"valueType": "string",
"profilePointer": "<string>",
"allowsAbsence": true,
"itemValueType": "<string>",
"constraints": {
"minLength": 1,
"maxLength": 2,
"pattern": "<string>"
}
},
"section": "<string>",
"reviewFeedback": {
"code": "<string>",
"message": "<string>"
}
}
],
"allowedSubmissionChannels": [
"direct_submission"
],
"verificationSessions": [
{
"id": "<string>",
"key": "<string>",
"type": "<string>",
"status": "action_required",
"url": "<string>",
"expiresAt": null
}
],
"tosSessions": [
{
"id": "<string>",
"key": "<string>",
"type": "<string>",
"status": "action_required",
"url": "<string>",
"expiresAt": null
}
],
"completionPolicy": {
"type": "requirements",
"completion": "all"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"originGroupId": "<string>"
}
}{
"type": "https://docs.swipelux.com/errors/unknown-parameter",
"title": "<string>",
"status": 400,
"code": "unknown_parameter",
"detail": "<string>",
"correlationId": "<string>",
"retryable": false,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"type": "https://docs.swipelux.com/errors/unauthorized",
"title": "<string>",
"status": 401,
"code": "unauthorized",
"detail": "<string>",
"correlationId": "<string>",
"retryable": false,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"type": "https://docs.swipelux.com/errors/forbidden",
"title": "<string>",
"status": 403,
"code": "forbidden",
"detail": "<string>",
"correlationId": "<string>",
"retryable": false,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"type": "https://docs.swipelux.com/errors/task-not-found",
"title": "<string>",
"status": 404,
"code": "task_not_found",
"detail": "<string>",
"correlationId": "<string>",
"retryable": false,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"type": "https://docs.swipelux.com/errors/internal-error",
"title": "<string>",
"status": 500,
"code": "internal_error",
"detail": "<string>",
"correlationId": "<string>",
"retryable": true,
"errors": [
{
"pointer": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}Related topics
Get task submission detailGet a taskIndividual onboarding API workflowGet customerQuickstart⌘I