Update an Account

PATCH {{baseUrl}}/v1/accounts/:account_id

This operation updates account information.

If all parameters are valid and updates have been made, it returns with status code 200. The response is the account model.

Request Body

{"contact"=>{"email_address"=>"john.doe@example.com", "phone_number"=>"+15556667788", "street_address"=>["20 N San Mateo Dr", "20 N San Mateo Dr"], "unit"=>"dolor fug", "city"=>"San Mateo", "state"=>"CA", "postal_code"=>"94401"}, "identity"=>{"given_name"=>"John", "family_name"=>"Doe", "date_of_birth"=>"1990-01-01", "tax_id"=>"666-55-4321", "tax_id_type"=>"USA_SSN", "country_of_citizenship"=>"AUS", "country_of_birth"=>"AUS", "country_of_tax_residence"=>"USA", "funding_source"=>["employment_income"]}, "disclosures"=>{"is_control_person"=>false, "is_affiliated_exchange_or_finra"=>false, "is_politically_exposed"=>false, "immediate_family_exposed"=>false}, "trusted_contact"=>{"given_name"=>"Jane", "family_name"=>"Doe", "email_address"=>"jane.doe@example.com"}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{"id":"20fbbb71-454f-4c69-a480-01d9e9c6f72f","account_number":"452906117","status":"ACTIVE","crypto_status":"INACTIVE","kyc_results":{"reject":{},"accept":{},"indeterminate":{},"summary":"pass"},"currency":"USD","last_equity":"0","created_at":"2024-03-22T15:47:57.572218Z","contact":{"email_address":"kind_carver_1304814912@example.com","phone_number":"070-555-6869","street_address":["20 N San Mateo Dr"],"local_street_address":null,"city":"San Mateo","state":"CA","postal_code":"94401"},"identity":{"given_name":"Kind","family_name":"Carver","date_of_birth":"1970-01-01","tax_id_type":"USA_SSN","country_of_citizenship":"USA","country_of_birth":"USA","country_of_tax_residence":"USA","funding_source":["employment_income"],"visa_type":null,"visa_expiration_date":null,"date_of_departure_from_usa":null,"permanent_resident":null,"investment_experience_with_stocks":null,"investment_experience_with_options":null,"investment_time_horizon":null},"disclosures":{"is_control_person":false,"is_affiliated_exchange_or_finra":false,"is_affiliated_exchange_or_iiroc":false,"is_politically_exposed":false,"immediate_family_exposed":false,"is_discretionary":false},"agreements":[{"agreement":"customer_agreement","signed_at":"2024-03-22T15:46:50.404783978Z","ip_address":"127.0.0.1","revision":"21.2023.06"}],"documents":[{"document_type":"identity_verification","document_sub_type":"passport","id":"3fadcdcb-0052-477e-80d4-942e47351145","content":"https://s3.amazonaws.com/sandbox.alpaca.markets/documents/owners/9d209d72-1796-4d57-9c30-a4152eeb76ef/3025bb5c-4f3e-4c26-815e-6b0643f529fd.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256\u0026X-Amz-Credential=AKIA4S4VCTSTLXZ7BRSG%2F20240322%2Fus-east-1%2Fs3%2Faws4_request\u0026X-Amz-Date=20240322T160642Z\u0026X-Amz-Expires=900\u0026X-Amz-SignedHeaders=host\u0026X-Amz-Signature=ed54396387cc1502499ffd2cae432ca3d52ffb237e0531940596a4768bbe3b70","created_at":"2024-03-22T15:47:46.58683Z"}],"trusted_contact":{"given_name":"Jane","family_name":"Doe","email_address":"kind_carver_30481491@example.com"},"account_type":"trading","trading_configurations":null,"enabled_assets":["us_equity"]}