GET Get-Client

Purpose
Users may send a client key through this call to receive a JSON object of the client's in system data.
Return Information
Variable Name Type Purpose
UUID Char Var An ID associated to that client.
ClientKey Char Var The unique ID used to identify the client through the API, used in other calls.
Name Char Var The company's name.
CompCode Char Var An abbreviated form of the client's name.
Address1 Char Var The mailing address of the client.
Address2 Char Var Additional information on the address, such as PO box # or suite #.
City Char Var Client's City.
State Char Var Client's State, in two character format.
ZipCode Char Var The Client's zipcode, supports non-American zipcode formats.
Country Char Var The client's country.
Phone Char Var Client's point of contact phone number.
PhoneAlt Char Var Client's secondary point of contact phone number.
Fax Char Var Client's fax number.
Email Char Var Client's primary point of contact email address.
UccDate Timestamp Without Time Zone Date the UCC is filed.
UccDate2 Timestamp Without Time Zone Date the UCC2 is filed.
UccSignedDate Timestamp Without Time Zone Date the UCC is signed.
Type Char Var Client's Business Type; 0 for carrier, 1 for broker.
Industry Integer Classification of the Client's general Industry; 1 for Transportation, 2 for Construction, 3 for Staffing, 4 for Oil & Gas, and 5 for General.
AltName Char Var NameSpace for a client's FKA or DBA name.
EdiID Char Var Client's ID for EDI transactions.
FedTaxNum Char Var Client's Federal Tax Number.
DunsNum Char Var Unique Identifier for the Data Universal Numbering System for businesses.
MCNumber Char Var Client's Motor Carrier Number.
DOTNumber Char Var Client's Department of Transportation Number.
CreditLimit Float The client's current credit limit in FactorCloud.
Expected Return
An echo JSON object with the above fields.
Example cURL Call
curl -H 'Auth-FactorId: FACTORID’ -H 'Auth-SystemKey: SYSTEMKEY’ -H 'Auth-ApiKey: APIKEY’ https://wstest.factorcloud.com/api_factor/get-client/?clientkey=EXAMPLE_CLIENT_KEY
Example Path
{
   https://wstest.factorcloud.com/api_factor/get-client/?clientkey=EXAMPLE_CLIENT_KEY
}
Example Return
{
   "Uuid":"ef372485-a935-c519-5a2f-5ea3abfc7741",
   "ClientKey":"a1e11ed9-6d93-4fcd-9d5a-d1f424a699c1",
   "Name":"My Special Company","CompCode":"MSC","Address1":"",
   "Address2":"","City":"","State":"","ZipCode":"","Country":"",
   "Phone":"","PhoneAlt":"","Fax":"","Email":"","UccDate":"2020-09-14T00:00:00Z",
   "UccDate2":"2020-09-14T00:00:00Z","UccSignedDate":"2020-09-14T00:00:00Z",
   "Type":"0","Industry":"1","AltName":"","EdiId":"","FedTaxNum":"","DunsNum":"",
   "MCNumber":"","DOTNumber":"","CreditLimit":"0.00"
}
Return to Index