Corserv Solutions REST APIs

Pre-Qualification Relationship Gateway
Virtual Card services for external API access
Authentication services for external API access
Account services for external API access
Brand Relationship Gateway
Payment services for external API access

Corserv Solutions REST APIs

Pre-Qualification Relationship Gateway
Virtual Card services for external API access
Authentication services for external API access
Account services for external API access
Brand Relationship Gateway
Payment services for external API access

Finds a relationship

get https://extapiai2-1602d:8443/api/v1/gateway/api/v2/gateway/relationship

Finds a relationship record for a given taxid and tax id type

URL Expired

The URL for this request expired after 30 days.

Headers

x-css-pci-ssn

string

required

The required 9 digit tax id number to find the record

x-css-pci-data-type

string

required

The required tax id type to find the record allowableValues = SSN, TAX_ID

Responses

Response body

object

dateCreated

date-time

The date this record was created

addressLine1

string

required

The address line 1, Max Length 50

addressLine2

string

The optional address line 2, Max Length 50

brand

string

required

The brand for this relationship record, Max Length 50

businessName

string

The optional business name, Max Length 50

city

string

required

The city, Max Length 50

customerEmailAddress

string

The optional customer email address, Max Length 50

customerSince

date-time

required

Date this relationship has been a customer (MM-dd-yyyy)

dob

date-time

The optional date of birth, MM-dd-yyyy

firstName

string

The optional first name, Max Length 50

brandRelationshipId

int32

The Corserv system generated unique identifier of this record

lastName

string

The optional last name, Max Length 50

memberNumber

string

The optional member number, Max Length 50

middleInitial

string

The optional middle initial, Max Length 1

officeOrBranchNumber

string

The optional office/branch number, Max Length 20

officerOrAdvisorNumber

string

The optional officer/advisor number, Max Length 7

postalCode

string

required

The postal code, Max Length 20

stateOrProvince

string

required

The state or province code, Max Length 20

taxId

string

required

The tax id, Max Length 50

taxIdType

string

required

The tax id type, Max Length 6

SSN TAX_ID

totalDepositBalance

int32

required

The total whole deposit balance this customer has, Max Length 10

totalProducts

int32

required

The total number of products this customer has, Max Length 10

vip

string

The optional VIP flag, Max Length 1

N Y

Response body

object

error

string

Not in use currently

errors

array of strings

A list of errors

errors

path

string

Not in use currently

status

string

Status

400 401 403 404 500

statusMessage

string

Status message

No records found Bad Request Unauthorized Internal Server Error The card was not found

timestamp

int64

Time stamp

Response body

object

error

string

Not in use currently

errors

array of strings

A list of errors

errors

path

string

Not in use currently

status

string

Status

400 401 403 404 500

statusMessage

string

Status message

No records found Bad Request Unauthorized Internal Server Error The card was not found

timestamp

int64

Time stamp

Response body

object

error

string

Not in use currently

errors

array of strings

A list of errors

errors

path

string

Not in use currently

status

string

Status

400 401 403 404 500

statusMessage

string

Status message

No records found Bad Request Unauthorized Internal Server Error The card was not found

timestamp

int64

Time stamp

Updated about 2 months ago

Deletes a relationship

Create a relationship record

Did this page help you?

Language

Credentials

OAuth2

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url https://extapiai2-1602d:8443/api/v1/gateway/api/v2/gateway/relationship \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated about 2 months ago

Deletes a relationship

Create a relationship record

Did this page help you?

Corserv Solutions REST APIs
Pre-Qualification Relationship Gateway
Pre-qualification applicationpost
Pre-qualification accountpost
Pre-qualification applicationpost
Pre-qualification accountpost
Virtual Card services for external API access
Delete virtual card vendordelete
Request virtual card vendor information for a companyget
Request virtual card information for a companyget
Request virtual card payment information for a vendorget
Request virtual card vendor detailsget
Submit virtual card paymentpost
Create virtual card vendorpost
Delete virtual card paymentdelete
Update virtual card paymentput
Request virtual card detailsget
Update virtual card vendorput
Authentication services for external API access
Login a card holder with SSOpost
Login a card holderpost
Register a card holderpost
Log in a client API user.post
Account services for external API access
Dashboard data for a card and accountget
Finds a statementget
Statement datesget
Transaction dataget
Program admin user name checkget
Consumer account creation requestpost
Non-Consumer account creation requestpost
Consumer credit line increaseput
Updates user profile emailput
Brand Relationship Gateway
Deletes a relationshipdelete
Create a relationship recordpost
Finds a relationshipget
Deletes a relationshipdelete
Create a relationship recordpost
Finds a relationshipget
Payment services for external API access
Cancel paymentdelete
Finds payment accountsget
Find payment historyget
Find scheduled paymentsget
Find payment post datesget
Create paymentpost
Create payment accountpost
Deletes payment accountdelete
Update payment accountput

Corserv Solutions REST APIs
Pre-Qualification Relationship Gateway
Pre-qualification applicationpost
Pre-qualification accountpost
Pre-qualification applicationpost
Pre-qualification accountpost
Virtual Card services for external API access
Delete virtual card vendordelete
Request virtual card vendor information for a companyget
Request virtual card information for a companyget
Request virtual card payment information for a vendorget
Request virtual card vendor detailsget
Submit virtual card paymentpost
Create virtual card vendorpost
Delete virtual card paymentdelete
Update virtual card paymentput
Request virtual card detailsget
Update virtual card vendorput
Authentication services for external API access
Login a card holder with SSOpost
Login a card holderpost
Register a card holderpost
Log in a client API user.post
Account services for external API access
Dashboard data for a card and accountget
Finds a statementget
Statement datesget
Transaction dataget
Program admin user name checkget
Consumer account creation requestpost
Non-Consumer account creation requestpost
Consumer credit line increaseput
Updates user profile emailput
Brand Relationship Gateway
Deletes a relationshipdelete
Create a relationship recordpost
Finds a relationshipget
Deletes a relationshipdelete
Create a relationship recordpost
Finds a relationshipget
Payment services for external API access
Cancel paymentdelete
Finds payment accountsget
Find payment historyget
Find scheduled paymentsget
Find payment post datesget
Create paymentpost
Create payment accountpost
Deletes payment accountdelete
Update payment accountput

200Relationship record was found

400Request data is invalid

403The user account does not have access to this brand

404The relationship record does not exist