Skip to main content
POST
/
api
/
v2
/
sos-filing-documents
/
Order SOS filing document
curl --request POST \
  --url https://ivs.idenfy.com/api/v2/sos-filing-documents/ \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "companyName": "<string>",
  "city": "<string>",
  "street": "<string>",
  "postalCode": "<string>"
}
'
import requests

url = "https://ivs.idenfy.com/api/v2/sos-filing-documents/"

payload = {
"companyName": "<string>",
"city": "<string>",
"street": "<string>",
"postalCode": "<string>"
}
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({
companyName: '<string>',
city: '<string>',
street: '<string>',
postalCode: '<string>'
})
};

fetch('https://ivs.idenfy.com/api/v2/sos-filing-documents/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
HttpResponse<String> response = Unirest.post("https://ivs.idenfy.com/api/v2/sos-filing-documents/")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"companyName\": \"<string>\",\n \"city\": \"<string>\",\n \"street\": \"<string>\",\n \"postalCode\": \"<string>\"\n}")
.asString();
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://ivs.idenfy.com/api/v2/sos-filing-documents/",
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([
'companyName' => '<string>',
'city' => '<string>',
'street' => '<string>',
'postalCode' => '<string>'
]),
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/api/v2/sos-filing-documents/")

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 \"companyName\": \"<string>\",\n \"city\": \"<string>\",\n \"street\": \"<string>\",\n \"postalCode\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
using RestSharp;


var options = new RestClientOptions("https://ivs.idenfy.com/api/v2/sos-filing-documents/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Basic <encoded-value>");
request.AddJsonBody("{\n \"companyName\": \"<string>\",\n \"city\": \"<string>\",\n \"street\": \"<string>\",\n \"postalCode\": \"<string>\"\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/api/v2/sos-filing-documents/"

payload := strings.NewReader("{\n \"companyName\": \"<string>\",\n \"city\": \"<string>\",\n \"street\": \"<string>\",\n \"postalCode\": \"<string>\"\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 \"companyName\": \"<string>\",\n \"city\": \"<string>\",\n \"street\": \"<string>\",\n \"postalCode\": \"<string>\"\n}")
val request = Request.Builder()
.url("https://ivs.idenfy.com/api/v2/sos-filing-documents/")
.post(body)
.addHeader("Authorization", "Basic <encoded-value>")
.addHeader("Content-Type", "application/json")
.build()

val response = client.newCall(request).execute()
import Foundation

let parameters = [
"companyName": "<string>",
"city": "<string>",
"street": "<string>",
"postalCode": "<string>"
] as [String : Any?]

let postData = try JSONSerialization.data(withJSONObject: parameters, options: [])

let url = URL(string: "https://ivs.idenfy.com/api/v2/sos-filing-documents/")!
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))
{
  "id": "<string>",
  "checkedAt": "2023-11-07T05:31:56Z",
  "dataFile": "<string>",
  "reportFile": "<string>",
  "companyName": "<string>",
  "formationDate": "2023-12-25",
  "watchlistHitsCount": -1
}

Authorizations

Authorization
string
header
required

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.

Body

application/json
companyName
string
required
Required string length: 1 - 255
state
enum<string>
required
Available options:
AK,
AL,
AR,
AZ,
CA,
CO,
CT,
DE,
FL,
GA,
HI,
IA,
ID,
IL,
IN,
KS,
KY,
LA,
MA,
MD,
ME,
MI,
MN,
MO,
MS,
MT,
NC,
ND,
NE,
NH,
NJ,
NM,
NV,
NY,
OH,
OK,
OR,
PA,
RI,
SC,
SD,
TN,
TX,
UT,
VA,
VT,
WA,
WI,
WV,
WY
city
string
required
Required string length: 1 - 100
street
string
required
Required string length: 1 - 255
postalCode
string
required
Required string length: 1 - 10
Pattern: ^\d{5}$

Response

201 - application/json
id
string
required
read-only
checkedAt
string<date-time> | null
status
enum<string>
Available options:
NOT_ORDERED,
IN_PROGRESS,
FINISHED,
FAILED,
TIMED_OUT
dataFile
string<uri> | null
Pattern: (?:json)$
reportFile
string<uri> | null
Pattern: (?:pdf)$
companyName
string | null
Maximum string length: 100
formationDate
string<date> | null
entityType
enum<string> | null
Available options:
CORPORATION,
LLC,
PARTNERSHIP,
NON_PROFIT,
TRUST,
SOLE_PROPRIETORSHIP
watchlistHitsCount
integer | null
Required range: -2147483648 <= x <= 2147483647