Company Search V1

post

https://processor-api.uat1.pcaasa.com/?call=company-search-v1

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

app

string

Defaults to customer-company

customer-company

object

string

Defaults to company

company

action

string

Defaults to search

version

int32

Defaults to 1

sessionUuid

string

The unique identifier that pertains to a particular session and is used to validate permissions

Data type: uuid
Required: yes
Letters: yes
Numbers: yes
Special: yes*
Min: 36
Max: 36

externalTranUuid

string

Identifier for tracking this API call

Data type: uuid
Required: yes
Letters: yes
Numbers: yes
Special: yes*
Min: 36
Max: 36

brandUuid

string

Data type: uuid
Required: no
Letters: yes
Numbers: yes
Special: yes*
Min: 36
Max: 36

brandName

string

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 2
Max: 50

holdingCompanyUuid

string

Optional holding company to which this company should be assigned

Data type: uuid
Required: no
Letters: yes
Numbers: yes
Special: yes*
Min: 36
Max: 36

companyUuid

string

Data type: uuid
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 36
Max: 36

referenceNumber

string

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 12
Max: 50

legalName

string

Name under which the company is legally registered

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 2
Max: 50

dbaName

string

'Doing Business As' name

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 2
Max: 50

dateEstablished

date

Date on which a company started

Data type: date
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 10
Max: 10

dateOpened

date

Date on which a company opened a credit line with our client (i.e. Bankers' Bank)

Data type: date
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 10
Max: 27

incorporationType

string

Special character allowed is spaces

Data type: string
Required: no
Letters: yes
Numbers: no
Special: yes
Min: 3
Max: 20

incorporationState

string

State where company is registered. Special character allowed is space

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 2
Max: 20

incorporationCountry

string

Country where company is registered. Special character allowed is space

Data type: string
Required: no
Letters: yes
Numbers: no
Special: yes
Min: 2
Max: 3

city

string

Special characters allowed are hyphen, apostrophe, and space (-'' )

Data type: string
Required: no
Letters: yes
Numbers: no
Special: yes
Min: 2
Max: 50

state

string

Special characters allowed are hyphen, apostrophe, and space (-'' )

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 2
Max: 20

postalCode

string

Special characters allowed are space and hyphen ( -)

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 3
Max: 20

country

string

Special character allowed: space

Data type: string
Required: no
Letters: yes
Numbers: no
Special: yes
Min: 1
Max: 50

offset

int32

Defaults to 0

Record to start with on returning results
Default is set to 0

Data type: number
Required: yes
Letters: no
Numbers: yes
Special: no
Min: 0
Max: 999,999

limit

int32

Defaults to 100

Number of rows returned
Default is set to 100
Max value is 1000

Data type: number
Required: yes
Letters: no
Numbers: yes
Special: yes
Min: 1
Max: 1000

debug

boolean

Defaults to false

Default is set to 0

Data type: boolean
Required: no
Letters: no
Numbers: yes
Special: no
Min: 1
Max: 1

Response

200200