Upload customer file

POST

customers

{customer_id}

files

curl --request POST \
  --url https://api.staging.streamlinedpayments.com/api/v1/customers/{customer_id}/files \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-App-Id: <api-key>' \
  --form file=@example-file

const form = new FormData();
form.append('file', '<string>');

const options = {method: 'POST', headers: {'X-App-Id': '<api-key>', 'X-Api-Key': '<api-key>'}};

options.body = form;

fetch('https://api.staging.streamlinedpayments.com/api/v1/customers/{customer_id}/files', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.staging.streamlinedpayments.com/api/v1/customers/{customer_id}/files"

files = { "file": ("example-file", open("example-file", "rb")) }
headers = {
    "X-App-Id": "<api-key>",
    "X-Api-Key": "<api-key>"
}

response = requests.post(url, files=files, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://api.staging.streamlinedpayments.com/api/v1/customers/{customer_id}/files")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-App-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "file": {
    "id": 123,
    "label": "credit_application",
    "label_name": "<string>",
    "category": "<string>",
    "url": "<string>",
    "filename": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

X-App-Id

string

header

required

App ID for authentication

X-Api-Key

string

header

required

API Key for authentication

Path Parameters

customer_id

string<uuid>

required

The UUID of the customer

Body

multipart/form-data

file

The file to upload

label

enum<string>

Allowed labels for customer files.

Available options:

credit_application,

personal_guarantee,

financial_statements,

credit_report,

sales_service_agreement,

payment_terms_agreement,

guarantee_security_agreement,

reseller_certificate,

non_disclosure_agreement,

tax_exemption_certificate,

business_license,

insurance_certificate,

shipping_contract,

bill_of_lading,

delivery_receipt,

memo,

customer_correspondence,

dispute_documentation,

other

Response

File uploaded successfully

file

object

Show child attributes

⌘I

Upload customer file

curl --request POST \
  --url https://api.staging.streamlinedpayments.com/api/v1/customers/{customer_id}/files \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-App-Id: <api-key>' \
  --form file=@example-file

const form = new FormData();
form.append('file', '<string>');

const options = {method: 'POST', headers: {'X-App-Id': '<api-key>', 'X-Api-Key': '<api-key>'}};

options.body = form;

fetch('https://api.staging.streamlinedpayments.com/api/v1/customers/{customer_id}/files', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.staging.streamlinedpayments.com/api/v1/customers/{customer_id}/files"

files = { "file": ("example-file", open("example-file", "rb")) }
headers = {
    "X-App-Id": "<api-key>",
    "X-Api-Key": "<api-key>"
}

response = requests.post(url, files=files, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://api.staging.streamlinedpayments.com/api/v1/customers/{customer_id}/files")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-App-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "file": {
    "id": 123,
    "label": "credit_application",
    "label_name": "<string>",
    "category": "<string>",
    "url": "<string>",
    "filename": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Orders

Customers

Customer applications

Customer groups

Customer files

Customer addresses

Payouts

Invoices

Transactions

Products

Deposit links

Webhooks

Authorizations

Path Parameters

Body

Response