Start Perflo Connection
curl --request POST \
--url https://api.example.com/v1/perflo-connectionsimport requests
url = "https://api.example.com/v1/perflo-connections"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/v1/perflo-connections', 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://api.example.com/v1/perflo-connections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$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://api.example.com/v1/perflo-connections"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/perflo-connections")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/perflo-connections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{
"account_hint": "<string>",
"action": {
"expires_at": "2023-11-07T05:31:56Z",
"poll_after_ms": 1,
"url": "<string>"
}
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}Onboarding
Start Perflo Connection
POST
/
v1
/
perflo-connections
Start Perflo Connection
curl --request POST \
--url https://api.example.com/v1/perflo-connectionsimport requests
url = "https://api.example.com/v1/perflo-connections"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/v1/perflo-connections', 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://api.example.com/v1/perflo-connections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$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://api.example.com/v1/perflo-connections"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/perflo-connections")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/perflo-connections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{
"account_hint": "<string>",
"action": {
"expires_at": "2023-11-07T05:31:56Z",
"poll_after_ms": 1,
"url": "<string>"
}
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"refresh_onboarding": true,
"request_id": "<string>",
"retryable": true,
"status": 123,
"submission_uncertain": true,
"title": "<string>",
"type": "<string>",
"fields": [
{}
]
}Response
Successful Response
A hosted provider hand-off: open url, optionally before expires_at, optionally polling for the outcome after poll_after_ms milliseconds.
card_reveal, grant_approval, and connect actions always carry expires_at, and grant_approval actions a positive poll_after_ms; a null expires_at occurs only on kyc_session, and a null poll_after_ms means no polling applies.
Show child attributes
Show child attributes
Available options:
pending, connected, reconnect_required, operator_action_required, not_connected ⌘I