Company Create V1

post

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

Body Params

app

string

Defaults to customer-company

customer-company

object

string

Defaults to company

company

action

string

Defaults to create

create

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: no
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

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

referenceNumber

string

If referenceNumber is not provided or is a blank string, a sixteen-digit, alpha-numeric referenceNumber will be generated

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: yes
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

paymentType

string

enum

Special character allowed: space

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

Allowed:

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

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

dunsNumber

string

A unique numeric identifier assigned to a single business entity, used in Dun & Bradstreets, a widely used registry for companies. Data Universal Numbering System

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

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

creditLine

int32

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

officerName

string

Contact for legal purposes. Special characters allowed are apostrophe, period, comma, and hyphen ('.,-)

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

contactName

string

Contact for other purposes. Special characters allowed are apostrophe, period, comma, and hyphen ('.,-)

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

phone

string

Special characters allowed are parentheses, hyphen, and space (()- )

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

addressLine1

string

Special characters allowed are hyphen, period, comma, apostrophe, hash, ampersand, forward slash, colon, and space (-.,''#&/: )

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

addressLine2

string

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

debug

boolean

Defaults to false

0 = debug off
1 = debug on
Default is set to 0

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

brandReferenceNumber

string

If brandUuid is not provided, brandReferenceNumber must be provided

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

holdingCompanyReferenceNumber

string

Optional for use instead of holdingCompanyUuid if this company will be associated with one

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

fintechUuid

string

The fintech to which the brand for this company should belong
If fintechReferenceNumber, brandUuid, or brandReferenceNumber are not provided, fintechUUid must be provided

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

fintechReferenceNumber

string

If fintechUuid, brandUuid, or brandReferenceNumber are not provided, fintechReferenceNumber must be provided

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

Response

200200