Request additional information from client
curl --request POST \
--url https://ivs.idenfy.com/kyc/identifications/{scanRef}/request-information/ \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"lifetime": 86400,
"questionnaire": "<string>",
"riskAssessmentProfile": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"additionalStepUploadRequired": true
}
'import requests
url = "https://ivs.idenfy.com/kyc/identifications/{scanRef}/request-information/"
payload = {
"lifetime": 86400,
"questionnaire": "<string>",
"riskAssessmentProfile": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"additionalStepUploadRequired": True
}
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({
lifetime: 86400,
questionnaire: '<string>',
riskAssessmentProfile: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
additionalStepUploadRequired: true
})
};
fetch('https://ivs.idenfy.com/kyc/identifications/{scanRef}/request-information/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://ivs.idenfy.com/kyc/identifications/{scanRef}/request-information/")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"lifetime\": 86400,\n \"questionnaire\": \"<string>\",\n \"riskAssessmentProfile\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"additionalStepUploadRequired\": true\n}")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://ivs.idenfy.com/kyc/identifications/{scanRef}/request-information/",
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([
'lifetime' => 86400,
'questionnaire' => '<string>',
'riskAssessmentProfile' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'additionalStepUploadRequired' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://ivs.idenfy.com/kyc/identifications/{scanRef}/request-information/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"lifetime\": 86400,\n \"questionnaire\": \"<string>\",\n \"riskAssessmentProfile\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"additionalStepUploadRequired\": true\n}"
response = http.request(request)
puts response.read_bodyusing RestSharp;
var options = new RestClientOptions("https://ivs.idenfy.com/kyc/identifications/{scanRef}/request-information/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Basic <encoded-value>");
request.AddJsonBody("{\n \"lifetime\": 86400,\n \"questionnaire\": \"<string>\",\n \"riskAssessmentProfile\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"additionalStepUploadRequired\": true\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://ivs.idenfy.com/kyc/identifications/{scanRef}/request-information/"
payload := strings.NewReader("{\n \"lifetime\": 86400,\n \"questionnaire\": \"<string>\",\n \"riskAssessmentProfile\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"additionalStepUploadRequired\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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))
}val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"lifetime\": 86400,\n \"questionnaire\": \"<string>\",\n \"riskAssessmentProfile\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"additionalStepUploadRequired\": true\n}")
val request = Request.Builder()
.url("https://ivs.idenfy.com/kyc/identifications/{scanRef}/request-information/")
.post(body)
.addHeader("Authorization", "Basic <encoded-value>")
.addHeader("Content-Type", "application/json")
.build()
val response = client.newCall(request).execute()import Foundation
let parameters = [
"lifetime": 86400,
"questionnaire": "<string>",
"riskAssessmentProfile": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"additionalStepUploadRequired": true
] as [String : Any?]
let postData = try JSONSerialization.data(withJSONObject: parameters, options: [])
let url = URL(string: "https://ivs.idenfy.com/kyc/identifications/{scanRef}/request-information/")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.timeoutInterval = 10
request.allHTTPHeaderFields = [
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
]
request.httpBody = postData
let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self)){
"sessionUrl": "<string>",
"tokenString": "<string>"
}Request additional information from client
POST
/
kyc
/
identifications
/
{scanRef}
/
request-information
/
Request additional information from client
curl --request POST \
--url https://ivs.idenfy.com/kyc/identifications/{scanRef}/request-information/ \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"lifetime": 86400,
"questionnaire": "<string>",
"riskAssessmentProfile": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"additionalStepUploadRequired": true
}
'import requests
url = "https://ivs.idenfy.com/kyc/identifications/{scanRef}/request-information/"
payload = {
"lifetime": 86400,
"questionnaire": "<string>",
"riskAssessmentProfile": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"additionalStepUploadRequired": True
}
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({
lifetime: 86400,
questionnaire: '<string>',
riskAssessmentProfile: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
additionalStepUploadRequired: true
})
};
fetch('https://ivs.idenfy.com/kyc/identifications/{scanRef}/request-information/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://ivs.idenfy.com/kyc/identifications/{scanRef}/request-information/")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"lifetime\": 86400,\n \"questionnaire\": \"<string>\",\n \"riskAssessmentProfile\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"additionalStepUploadRequired\": true\n}")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://ivs.idenfy.com/kyc/identifications/{scanRef}/request-information/",
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([
'lifetime' => 86400,
'questionnaire' => '<string>',
'riskAssessmentProfile' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'additionalStepUploadRequired' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://ivs.idenfy.com/kyc/identifications/{scanRef}/request-information/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"lifetime\": 86400,\n \"questionnaire\": \"<string>\",\n \"riskAssessmentProfile\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"additionalStepUploadRequired\": true\n}"
response = http.request(request)
puts response.read_bodyusing RestSharp;
var options = new RestClientOptions("https://ivs.idenfy.com/kyc/identifications/{scanRef}/request-information/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Basic <encoded-value>");
request.AddJsonBody("{\n \"lifetime\": 86400,\n \"questionnaire\": \"<string>\",\n \"riskAssessmentProfile\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"additionalStepUploadRequired\": true\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://ivs.idenfy.com/kyc/identifications/{scanRef}/request-information/"
payload := strings.NewReader("{\n \"lifetime\": 86400,\n \"questionnaire\": \"<string>\",\n \"riskAssessmentProfile\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"additionalStepUploadRequired\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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))
}val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"lifetime\": 86400,\n \"questionnaire\": \"<string>\",\n \"riskAssessmentProfile\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"additionalStepUploadRequired\": true\n}")
val request = Request.Builder()
.url("https://ivs.idenfy.com/kyc/identifications/{scanRef}/request-information/")
.post(body)
.addHeader("Authorization", "Basic <encoded-value>")
.addHeader("Content-Type", "application/json")
.build()
val response = client.newCall(request).execute()import Foundation
let parameters = [
"lifetime": 86400,
"questionnaire": "<string>",
"riskAssessmentProfile": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"additionalStepUploadRequired": true
] as [String : Any?]
let postData = try JSONSerialization.data(withJSONObject: parameters, options: [])
let url = URL(string: "https://ivs.idenfy.com/kyc/identifications/{scanRef}/request-information/")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.timeoutInterval = 10
request.allHTTPHeaderFields = [
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
]
request.httpBody = postData
let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self)){
"sessionUrl": "<string>",
"tokenString": "<string>"
}Authorizations
The request must contain basic auth headers where username is API key and password is API secret.
In order for you to start using our API you will need an API key and API secret.
Both can be retrieved by contacting iDenfy's support or iDenfy's sales team.
Path Parameters
Body
application/json
Was this page helpful?
⌘I