Account Holder

1. Create Account Holder

📘
Note the response's id attribute for account creation. You'll also see duplicate fields below for backwards compatibility as we move towards consistent field naming conventions in our API.

POST https://sandbox.conduit.financial/account-holders

{
  "data": {
    "type": "account-holder",
    "attributes": {
      "businessName": "Pear Inc.",
      "firstName": "John", // If Business, enter legal representatives info.
      "lastName": "Smith", // If Business, enter legal representatives info.
      "middleName": "Marvin", // If Business, enter legal representatives info.
      "address": {
        "streetNumber": "55",
        "streetName": "Jump Street",
        "aptUnitSuiteFloor": "Apt 21",
        "city": "Santiago",
        "stateProvince": "RM",
        "postalCode": "1000000",
        "country": "CL"
      },
      "dateOfBirth": "2019-08-24", // If Business, enter date of incorporation.
      "nationality": "CL", // If Business, enter country of incorporation.
      "taxNumber":"775885567",
      "email":"[email protected]",
      "phone":"+56912345678",
      "externalId": "null"
    }
  }
}

{
    "data": {
        "id": "id:ahl:2J8Ocs7KFZJt3CMPi9f0x8UCCQ0",
        "type": "account-holder",
        "attributes": {
            "externalId": "null",
            "firstName": "John",
            "lastName": "Smith",
            "middleName": "Marvin",
            "verificationStatus": "pending",
            "taxNumber": "775885567",
            "businessName": "Pear Inc.",
            "phone": "+56912345678",
            "email": "[email protected]",
            "address": {
                "streetNumber": "55",
                "streetName": "Jump Street",
                "street": "Jump Street",
                "aptUnitSuiteFloor": "Apt 21",
                "apt_suite_flat_etc": "Apt 21",
                "city": "Santiago",
                "stateProvince": "RM",
                "postalCode": "1000000",
                "postal_zip_code": "1000000",
                "country": "CHL"
            },
            "dateOfBirth": "2019-08-24",
            "nationality": "CHL"
        },
        "relationships": {
            "accounts": {
                "links": {
                    "self": "/account-holders/id:ahl:2J8Ocs7KFZJt3CMPi9f0x8UCCQ0/relationships/accounts",
                    "first": "/account-holders/id:ahl:2J8Ocs7KFZJt3CMPi9f0x8UCCQ0/relationships/accounts",
                    "next": null,
                    "related": "/account-holders/id:ahl:2J8Ocs7KFZJt3CMPi9f0x8UCCQ0/accounts",
                    "prev": null
                },
                "data": []
            }
        }
    }
}

2. Change Compliance Status

In our Sandbox environment ONLY, you can simulate various sanctions screening scenarios by altering the account holder's compliance status. In our Live environment, sanctions screening is automated and you will not need to or be able to simulate different scenarios.

Learn more about our sanctions screening process here.

📘
Newly created Account Holders will start off as pending so in order to successfully create an account or transaction in Sandbox, you'll need to use the compliance simulation endpoint below to change the status to approved first.

POST https://sandbox.conduit.financial/simulator/compliance

Replace the Account Holder id with the one you noted down.
Change complianceStatus to approved.

{
  "data": {
    "type": "account-holder",
    "attributes": {
      "id": "id:ahl:2J8Ocs7KFZJt3CMPi9f0x8UCCQ0",
      "complianceStatus": "approved"
    }
  }
}