Create customer file
curl --request POST \
--url https://api.example.com/v1/uploads/customer/{customer_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"file_name": "<string>",
"content": "aSDinaTvuI8gbWludGxpZnk=",
"approval_needed": 123,
"approval_made": 123,
"signature_needed": 123,
"signature_made": 123,
"active": true,
"metadata": {}
}
'import requests
url = "https://api.example.com/v1/uploads/customer/{customer_id}"
payload = {
"file_name": "<string>",
"content": "aSDinaTvuI8gbWludGxpZnk=",
"approval_needed": 123,
"approval_made": 123,
"signature_needed": 123,
"signature_made": 123,
"active": True,
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
file_name: '<string>',
content: 'aSDinaTvuI8gbWludGxpZnk=',
approval_needed: 123,
approval_made: 123,
signature_needed: 123,
signature_made: 123,
active: true,
metadata: {}
})
};
fetch('https://api.example.com/v1/uploads/customer/{customer_id}', 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/uploads/customer/{customer_id}",
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([
'file_name' => '<string>',
'content' => 'aSDinaTvuI8gbWludGxpZnk=',
'approval_needed' => 123,
'approval_made' => 123,
'signature_needed' => 123,
'signature_made' => 123,
'active' => true,
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.example.com/v1/uploads/customer/{customer_id}"
payload := strings.NewReader("{\n \"file_name\": \"<string>\",\n \"content\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"approval_needed\": 123,\n \"approval_made\": 123,\n \"signature_needed\": 123,\n \"signature_made\": 123,\n \"active\": true,\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.example.com/v1/uploads/customer/{customer_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"file_name\": \"<string>\",\n \"content\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"approval_needed\": 123,\n \"approval_made\": 123,\n \"signature_needed\": 123,\n \"signature_made\": 123,\n \"active\": true,\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/uploads/customer/{customer_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"file_name\": \"<string>\",\n \"content\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"approval_needed\": 123,\n \"approval_made\": 123,\n \"signature_needed\": 123,\n \"signature_made\": 123,\n \"active\": true,\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"file_name": "<string>",
"document_type": "<string>",
"approval_needed": 123,
"approval_made": 123,
"signature_needed": 123,
"signature_made": 123,
"content_length": 123,
"file_extension": "<string>",
"active": true,
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"code": "common.invalid_file_extension",
"message": "Invalid file type"
}Customer Documents
Create customer file
Upload a file for a specific customer
POST
/
v1
/
uploads
/
customer
/
{customer_id}
Create customer file
curl --request POST \
--url https://api.example.com/v1/uploads/customer/{customer_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"file_name": "<string>",
"content": "aSDinaTvuI8gbWludGxpZnk=",
"approval_needed": 123,
"approval_made": 123,
"signature_needed": 123,
"signature_made": 123,
"active": true,
"metadata": {}
}
'import requests
url = "https://api.example.com/v1/uploads/customer/{customer_id}"
payload = {
"file_name": "<string>",
"content": "aSDinaTvuI8gbWludGxpZnk=",
"approval_needed": 123,
"approval_made": 123,
"signature_needed": 123,
"signature_made": 123,
"active": True,
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
file_name: '<string>',
content: 'aSDinaTvuI8gbWludGxpZnk=',
approval_needed: 123,
approval_made: 123,
signature_needed: 123,
signature_made: 123,
active: true,
metadata: {}
})
};
fetch('https://api.example.com/v1/uploads/customer/{customer_id}', 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/uploads/customer/{customer_id}",
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([
'file_name' => '<string>',
'content' => 'aSDinaTvuI8gbWludGxpZnk=',
'approval_needed' => 123,
'approval_made' => 123,
'signature_needed' => 123,
'signature_made' => 123,
'active' => true,
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.example.com/v1/uploads/customer/{customer_id}"
payload := strings.NewReader("{\n \"file_name\": \"<string>\",\n \"content\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"approval_needed\": 123,\n \"approval_made\": 123,\n \"signature_needed\": 123,\n \"signature_made\": 123,\n \"active\": true,\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.example.com/v1/uploads/customer/{customer_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"file_name\": \"<string>\",\n \"content\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"approval_needed\": 123,\n \"approval_made\": 123,\n \"signature_needed\": 123,\n \"signature_made\": 123,\n \"active\": true,\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/uploads/customer/{customer_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"file_name\": \"<string>\",\n \"content\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"approval_needed\": 123,\n \"approval_made\": 123,\n \"signature_needed\": 123,\n \"signature_made\": 123,\n \"active\": true,\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"file_name": "<string>",
"document_type": "<string>",
"approval_needed": 123,
"approval_made": 123,
"signature_needed": 123,
"signature_made": 123,
"content_length": 123,
"file_extension": "<string>",
"active": true,
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"code": "common.invalid_file_extension",
"message": "Invalid file type"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Response
File created successfully
Available options:
pending, approved, attached Available options:
pending, signed, not_required ⌘I