POST
/
v2
/
accounts
/
sub_account_holder
/
{sub_account_holder_id}
/
kyc
Submit a KYC
curl --request POST \
  --url https://api.sandbox.solidfi.com/v2/accounts/sub_account_holder/{sub_account_holder_id}/kyc \
  --header 'api-key: <api-key>'
{
  "id": "sah_5ccfeef0adf0cbe2aa0980d2c9509b2d",
  "client_id": "cli_64c6c87ee9d609f36a6f390dc378a4ce",
  "master_account_holder_id": "mah_201e02c581a098a740456c5c19fcfcd6",
  "master_account_id": "mas_743fa071316bc6beaf5dddfd05f49c30",
  "type": "person",
  "person": {
    "first_name": "Jane",
    "last_name": "Doe",
    "id_type": "ssn",
    "id_number": "223913234",
    "date_of_birth": "1974-01-25",
    "phone": "+19418405843",
    "email": "jane.doe@gmail.com",
    "address": {
      "line1": "123 Main St",
      "line2": "",
      "city": "New York",
      "state": "NY",
      "country": "US",
      "postal_code": "10001"
    },
    "kyc": {
      "id": "kyc_01arz3ndektsv4rrffq69g5fav",
      "status": "pass",
      "method": "solid",
      "url": "https://dashboard.solidfi.com/verify?id=kyc_01arz3ndektsv4rrffq69g5fav",
      "details": {
        "name": {
          "status": "pass",
          "reasons": null
        },
        "address": {
          "status": "pass",
          "reasons": null
        },
        "dob": {
          "status": "pass",
          "reasons": null
        },
        "ssn": {
          "status": "pass",
          "reasons": null
        },
        "phone": {
          "status": "pass",
          "reasons": null
        },
        "email": {
          "status": "pass",
          "reasons": null
        },
        "watchlist": {
          "status": "pass",
          "reasons": null
        },
        "fraud": {
          "status": "pass",
          "reasons": null
        }
      }
    },
    "idv": {
      "id": "idv_01arz3ndektsv4rrffq69g5fav",
      "status": "fail",
      "method": "solid",
      "url": "https://dashboard.solidfi.com/id=idv_01arz3ndektsv4rrffq69g5fav",
      "reasons": null
    }
  },
  "business": null,
  "ofac": {
    "status": "pass",
    "last_updated_at": "2024-04-01T21:00:00Z"
  },
  "external_reference_id": "TW-9L1L2-UVV",
  "purpose": "Ace sub-account holder",
  "attachments": [
    {
      "label": "formation",
      "id": "att_a8d2b191fa0e960d8e49a4bfd320e07b",
      "created_at": "2024-04-01T21:00:00Z"
    }
  ],
  "metadata": {
    "customer_code": "1501"
  },
  "status": "activated",
  "timestamps": {
    "created_at": "2024-04-01T21:00:00Z",
    "updated_at": "2024-04-01T21:00:00Z",
    "deactivated_at": "2024-04-01T21:00:00Z"
  }
}

Headers

​
api-key
string
required

API key is required to call Solid APIs. You can view and manage your API keys in the Solid dashboard.

Example:

"{{api_key}}"

Path Parameters

​
sub_account_holder_id
string
required

Response

Submit a KYC

​
id
string

unique id of the sub account holder

Example:

"sah_5ccfeef0adf0cbe2aa0980d2c9505752"

​
client_id
string

unique id of the client that created the sub account

Example:

"cli_64c6c87ee9d609f36a6f390dc378a4ce"

​
master_account_holder_id
string

unique id of the master account holder

Example:

"mah_201e02c581a098a740456c5c19fcfcd6"

​
master_account_id
string

unique id of the master account

Example:

"mas_743fa071316bc6beaf5dddfd05f49c30"

​
person
object
​
business
object
​
ofac
object
​
external_reference_id
string

unique id to cross-reference records with external systems

Example:

"TW-9L1L2-UVV"

​
purpose
string

purpose of sub account holder

Example:

"Ace sub-account holder"

​
attachments
object[]
​
metadata
object

Metadata takes free-form key-value pairs. You may send metadata when you create an object (POST) and when updating the object (PATCH). If you would like to remove metadata that is already on an object, you can unset it by passing in the key-value pair with an empty string, like this: {"key": ""}

​
status
enum<string>

status of sub account holder

Available options:
pending_activation,
activated,
suspended,
deactivated,
locked
Example:

"activated"

​
timestamps
object