ALalpacahq
KYC

Retrieve CIP information

You can retrieve the CIP information you've submitted for a given account.

get/v1/accounts/{account_id}/cip

Request

  • Base URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets
  • URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets/v1/accounts/{account_id}/cip
  • Auth
    HTTP basic

Response

OK

account_idstring uuid

UUID of the Account instance this CIPInfo is for

created_atstring date-time
idstring uuid

ID of this CIPInfo

provider_nameCIPProvider[]

List of KYC providers this information came from

updated_atstring date-time

Example response

{
  "document": {
    "created_at": "2021-06-10T15:37:03Z",
    "id": "55B9931A-3BE6-4BC0-9BDD-0B954E4A4632",
    "image_integrity": "clear",
    "result": "clear",
    "status": "complete"
  },
  "identity": {
    "address": "clear",
    "created_at": "2021-06-10T15:37:03Z",
    "date_of_birth": "clear",
    "id": "28E1CCE8-1B1A-4472-9AD4-C6C5B7C3A6AF",
    "result": "clear",
    "sources": "clear",
    "status": "complete"
  },
  "kyc": {
    "address": "42 Faux St",
    "applicant_name": "John Doe",
    "approval_status": "approved",
    "approved_at": "2021-06-10T15:38:03Z",
    "approved_by": "Jane Doe",
    "check_completed_at": "2021-06-10T15:37:03Z",
    "check_initiated_at": "2021-06-10T15:37:03Z",
    "country_of_residency": "USA",
    "date_of_birth": "1970-12-01",
    "email_address": "johndoe@example.com",
    "id": "CBDAD1C4-1047-450E-BAE5-B6C406F509B4",
    "id_number": "jd0000123456789",
    "ip_address": "127.0.0.1",
    "kyc_completed_at": "2021-06-10T15:37:03Z",
    "nationality": "American",
    "postal_code": "94401",
    "risk_level": "LOW"
  },
  "photo": {
    "created_at": "2021-06-10T15:37:03Z",
    "face_comparison": "clear",
    "id": "0DD13020-F0FD-4B5A-B58F-BC1885E90A6D",
    "result": "clear",
    "status": "complete"
  },
  "watchlist": {
    "adverse_media": "clear",
    "created_at": "2021-06-10T15:37:03Z",
    "id": "7572B870-EB4C-46A2-8B88-509194CCEE7E",
    "monitored_lists": "clear",
    "politically_exposed_person": "clear",
    "result": "clear",
    "sanction": "clear",
    "status": "complete"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.