Revisions
Date | Revision |
8/5/2015 |
|
6/3/2015 | Added url endpoints Debt reinvestment, posting interest and principal to debt assets as well as selling/maturing a debt asset Added models |
Required Headers
All CrowdPay API calls must have the following request headers with the provided Api key and Portal / Escrow key.
X-ApiKey | Api Key provided by GoldStar Trust |
X-PortalKey | Portal / Escrow Key provided by Goldstar Trust |
X-ByPassValidation | Set to True or False. Only functional in QA (sandbox) – This header is used to bypass normal production validation that would normally prevent transactional processing. |
Revisions
Date | Revision |
---|---|
8/5/2015 |
|
6/3/2015 | Added url endpoints Debt reinvestment, posting interest and principal to debt assets as well as selling/maturing a debt asset Added models |
Investor Object
Parameter | Required | Type | Description |
---|---|---|---|
id | N | Long | Identifier for account |
investor_key | N | GUID | Portal's key used when calling the “Get Investor Information” api. |
tax_id_number | Y | String | MinLength(9) MaxLength(9) |
first_name | N | String | MaxLength(50) |
middle_name | N | String | MaxLength(50) |
last_name | N | String | MaxLength(50) |
name | N | String | MaxLength(150) |
birth_date | N | Date | |
mailing_address_1 | N | String | MaxLength(40) |
mailing_address_2 | N | String | MaxLength(40) |
mailing_city | N | String | MaxLength(40) |
mailing_state | N | String | MaxLength(30) |
mailing_zip | N | String | MaxLength(9) |
mailing_country | N | String | MaxLength(40) |
is_mailing_address_foreign | Y | Bool | |
legal_address_1 | N | String | MaxLength(40) |
legal_address_2 | N | String | MaxLength(40) |
legal_city | N | String | MaxLength(40) |
legal_state | N | String | MaxLength(30) |
legal_zip | N | String | MaxLength(9) |
legal_country | N | String | MaxLength(40) |
is_legal_address_foreign | N | Bool | |
primary_phone | N | String | MaxLength(10) |
secondary_phone | N | String | MaxLength(10) |
is_person | Y | Bool | True indicates the investor is a person |
N | String | MaxLength(50) | |
is_cip_satisfied | Y | Bool | |
portal_investor_number | N | String | MaxLength(30) |
created_by_ip_address | Y | String | MaxLength(25) |
Accounts | N | Icollection<Accounts> |
Account Object
Parameter | Required | Type | Description |
id | N | Long | Identifier for account |
number | N | String | MaxLength(15) |
portal_account_number | N | String | MaxLength(30) |
investor_id | Y | Long | |
name_1 | N | String | MaxLength(50) |
name_2 | N | String | MaxLength(50) |
name_3 | N | String | MaxLength(50) |
name_4 | N | String | MaxLength(50) |
mailing_address_1 | N | String | MaxLength(40) |
mailing_address_2 | N | String | MaxLength(40) |
mailing_city | N | String | MaxLength(40) |
mailing_state | N | String | MaxLength(30) |
mailing_zip | N | String | MaxLength(9) |
mailing_country | N | String | MaxLength(40) |
is_mailing_address_foreign | Y | Bool | |
current_uninvested_cash | N | Decimal | |
uninvested_cash | N | Decimal | |
is_cip_satisfied | Y | Bool | is a valid user - verified identity |
draft_account_type_id | Y | Int | 1=Checking, 2=Savings |
draft_routing_number | Y | String | MaxLength(9) |
draft_account_number | Y | String | MaxLength(17) |
draft_account_name | Y | String | MaxLength(50) |
status_id | Y | Int | 1=Open, 2=Closed, 3=Pending |
account_type_id | Y | Int | 2=Traditional IRA, 11=Roth IRA 12=Non IRA |
w9_code_id | Y | Int | 1=Received W-9/No Withholding 2=W-9 Not Received/Withholding 3=Mandatory Withholding 4=Exempt From Reporting 5=Corporate - No Reporting 6=Foreign Resident 7=W-8 Non US Citizen |
contact_name | N | String | MaxLength(75) |
contact_phone | N | String | MaxLength(20) |
contact_email | N | String | MaxLength(50) |
idology_id | N | Long | |
created_by_ip_address | Y | String | MaxLength(25) |
Assets | N | ICollection<Assets> | Collection of escrows |
Transactions | N | ICollection<Transaction> |
Asset Object
Parameter | Required | Type | Description |
id | N | Long | Identifier for asset |
description | N | String | |
number | N | Number | |
sold_date | N | DateTime | |
market_value | N | Decimal | |
Transactions | N | ICollection<Transaction> |
Transaction Object
Parameter | Required | Type | Description |
id | N | Long | Identifier for transaction |
account_id | Y | Long | |
asset_id | N | Long | |
date | N | DateTime | |
reference | N | String | MaxLength(20) |
description | N | String | MaxLength(50) |
decimal_amount | Y | Decimal | |
Status | N | String | |
created_by_ip_address | Y | String | MaxLength(25) |