{ "components" : { "securitySchemes" : { "apiKey" : { "bearerFormat" : "JWT", "scheme" : "bearer", "type" : "http" }, "basicAuth" : { "scheme" : "basic", "type" : "http" } } }, "info" : { "contact" : { "email" : "help@treasuryprime.com", "name" : "Treasury Prime Support", "url" : "https://support.treasuryprime.com" }, "summary" : "Banking APIs", "termsOfService" : "https://www.treasuryprime.com/policy/terms", "title" : "Account Opening", "version" : "1.18.731-gcbd60cfd" }, "openapi" : "3.1.0", "paths" : { "/account_number_reservation" : { "get" : { "parameters" : [ { "in" : "query", "name" : "account_product_id", "schema" : { "type" : "string" } }, { "description" : "Pagination cursor, value is the object ID.", "in" : "query", "name" : "page_cursor", "schema" : { "type" : "string" } }, { "description" : "Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.", "in" : "query", "name" : "page_size", "schema" : { "default" : 100, "minimum" : 1, "type" : "integer" } }, { "description" : "Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in" : "query", "name" : "from_date", "schema" : { "type" : "string" } }, { "description" : "Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in" : "query", "name" : "to_date", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "examples" : { }, "schema" : { "properties" : { "data" : { "items" : { "properties" : { "account_number" : { "type" : "string" }, "account_product_id" : { "type" : "string" }, "id" : { "type" : "string" } }, "type" : "object" }, "type" : "array" } } } } }, "description" : "A dictionary with a `data` property that contains a list of up to `page_size` account-number-reservation elements, starting after the account-number-reservation described by `page_cursor`. If no more account-number-reservations are available, the resulting list will be empty." } }, "summary" : "index account-number-reservation" }, "post" : { "requestBody" : { "content" : { "application/json" : { "examples" : { }, "schema" : { "properties" : { "account_product_id" : { "type" : "string" } }, "required" : [ "id", "account_product_id" ] } } }, "description" : "The account-number-reservation to create", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "examples" : { }, "schema" : { "properties" : { "account_number" : { "type" : "string" }, "account_product_id" : { "type" : "string" }, "id" : { "type" : "string" } } } } }, "description" : "The account-number-reservation created" } }, "summary" : "create account-number-reservation" } }, "/account_number_reservation/{id}" : { "get" : { "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "examples" : { }, "schema" : { "properties" : { "account_number" : { "type" : "string" }, "account_product_id" : { "type" : "string" }, "id" : { "type" : "string" } } } } }, "description" : "The account-number-reservation" } }, "summary" : "get account-number-reservation" } }, "/account_product" : { "get" : { "parameters" : [ { "description" : "The type of account, such as `checking` or `savings`. Filterable.", "in" : "query", "name" : "account_type", "schema" : { "type" : "string" } }, { "description" : "ID of the FBO associated with this account product. Filterable.", "in" : "query", "name" : "fbo_id", "schema" : { "type" : "string" } }, { "description" : "Descriptive name of the account product. Filterable.", "in" : "query", "name" : "name", "schema" : { "type" : "string" } }, { "description" : "One of `business` or `personal`. Filterable.", "in" : "query", "name" : "ownership", "schema" : { "type" : "string" } }, { "description" : "Pagination cursor, value is the object ID.", "in" : "query", "name" : "page_cursor", "schema" : { "type" : "string" } }, { "description" : "Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.", "in" : "query", "name" : "page_size", "schema" : { "default" : 100, "minimum" : 1, "type" : "integer" } }, { "description" : "Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in" : "query", "name" : "from_date", "schema" : { "type" : "string" } }, { "description" : "Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in" : "query", "name" : "to_date", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Success", "value" : { "data" : [ { "account_type" : "checking", "created_at" : "2021-10-27T18:56:55Z", "id" : "apt_11gqk87qmrax", "name" : "Personal checking", "ownership" : "personal", "updated_at" : "2021-10-27T18:56:55Z", "userdata" : null } ] } } }, "schema" : { "properties" : { "data" : { "items" : { "properties" : { "account_type" : { "description" : "The type of account, such as `checking` or `savings`. Filterable.", "type" : "string" }, "apply_workflow" : { "description" : "Field representing the apply workflow pertaining to this account product.", "type" : "string" }, "business_kyc_product_id" : { "description" : "ID of the KYC Product used to evaluate business applications", "type" : "string" }, "fbo_id" : { "description" : "ID of the FBO associated with this account product. Filterable.", "type" : "string" }, "id" : { "description" : "Unique identifier for object", "type" : "string" }, "name" : { "description" : "Descriptive name of the account product. Filterable.", "type" : "string" }, "ownership" : { "description" : "One of `business` or `personal`. Filterable.", "type" : "string" }, "person_kyc_product_id" : { "description" : "ID of the KYC Product used to evaluate person applications", "type" : "string" }, "userdata" : { "description" : "Optional arbitrary data the user can attach to the object", "type" : "object" } }, "type" : "object" }, "type" : "array" } } } } }, "description" : "A dictionary with a `data` property that contains a list of up to `page_size` account_product elements, starting after the account_product described by `page_cursor`. If no more account_products are available, the resulting list will be empty." } }, "summary" : "List Account Products", "tags" : [ "Account Product" ] } }, "/account_product/{id}" : { "get" : { "parameters" : [ { "description" : "Unique identifier for object", "in" : "path", "name" : "id", "required" : true, "schema" : { "description" : "Unique identifier for object", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Success", "value" : { "account_type" : "checking", "created_at" : "2021-10-27T18:56:55Z", "id" : "apt_11gqk87qmrax", "name" : "Personal checking", "ownership" : "personal", "updated_at" : "2021-10-27T18:56:55Z", "userdata" : null } } }, "schema" : { "properties" : { "account_type" : { "description" : "The type of account, such as `checking` or `savings`. Filterable.", "type" : "string" }, "apply_workflow" : { "description" : "Field representing the apply workflow pertaining to this account product.", "type" : "string" }, "business_kyc_product_id" : { "description" : "ID of the KYC Product used to evaluate business applications", "type" : "string" }, "fbo_id" : { "description" : "ID of the FBO associated with this account product. Filterable.", "type" : "string" }, "id" : { "description" : "Unique identifier for object", "type" : "string" }, "name" : { "description" : "Descriptive name of the account product. Filterable.", "type" : "string" }, "ownership" : { "description" : "One of `business` or `personal`. Filterable.", "type" : "string" }, "person_kyc_product_id" : { "description" : "ID of the KYC Product used to evaluate person applications", "type" : "string" }, "userdata" : { "description" : "Optional arbitrary data the user can attach to the object", "type" : "object" } } } } }, "description" : "The account_product" } }, "summary" : "Fetch an Account Product", "tags" : [ "Account Product" ] } }, "/apply/account_application" : { "get" : { "parameters" : [ { "description" : "ID of the Account object that is created as a result of a successful application. Filterable.", "in" : "query", "name" : "account_id", "schema" : { "type" : "string" } }, { "description" : "ID of an Account Product object that determines what kind of account is created. Filterable.", "in" : "query", "name" : "account_product_id", "schema" : { "type" : "string" } }, { "description" : "ID of the Business Application object for the business applying for the account. Only needed for business accounts. Filterable.", "in" : "query", "name" : "business_application_id", "schema" : { "type" : "string" } }, { "description" : "One of: `business`, `personal`. Filterable.", "in" : "query", "name" : "ownership_type", "schema" : { "type" : "string" } }, { "description" : "ID of the Person Application object representing the primary person applicant. Filterable.", "in" : "query", "name" : "primary_person_application_id", "schema" : { "type" : "string" } }, { "description" : "One of: `unsubmitted`, `submitted`, `canceled`, `kyc`, `processing`, `manual_review`, `rejected`, or `approved`. Indicates the current status of the application as it is evaluated. Filterable.", "in" : "query", "name" : "status", "schema" : { "type" : "string" } }, { "description" : "Pagination cursor, value is the object ID.", "in" : "query", "name" : "page_cursor", "schema" : { "type" : "string" } }, { "description" : "Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.", "in" : "query", "name" : "page_size", "schema" : { "default" : 100, "minimum" : 1, "type" : "integer" } }, { "description" : "Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in" : "query", "name" : "from_date", "schema" : { "type" : "string" } }, { "description" : "Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in" : "query", "name" : "to_date", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Success", "value" : { "data" : [ { "account_id" : null, "account_number_reservation_id" : null, "account_product_id" : "apt_11gqk87qmrax", "bankdata" : null, "business_application_id" : "abus_01dcrqkr3yhw", "created_at" : "2019-03-15T11:55:14Z", "deposit_id" : "adpt_01d5wgg8js", "id" : "aact_01jkw68sjab33", "person_applications" : [ ], "primary_person_application_id" : "apsn_01d5w6yaa6vt", "status" : "submitted", "updated_at" : "2019-03-15T11:55:14Z", "userdata" : null }, { "account_id" : null, "account_number_reservation_id" : null, "account_product_id" : "apt_11gqk87qmrax", "bankdata" : null, "business_application_id" : null, "created_at" : "2019-03-15T11:55:14Z", "deposit_id" : "adpt_01d5w6xx0tvs", "id" : "aact_01d5w6xb72vr", "person_applications" : [ { "id" : "apsn_01d5w6yaa6vt", "roles" : [ "owner", "signer" ] } ], "primary_person_application_id" : "apsn_01d5w6yaa6vt", "status" : "submitted", "updated_at" : "2019-03-15T11:55:14Z", "userdata" : null } ] } } }, "schema" : { "properties" : { "data" : { "items" : { "properties" : { "account_id" : { "description" : "ID of the Account object that is created as a result of a successful application. Filterable.", "type" : "string" }, "account_number" : { "description" : "Account number associated with Account object that is created as a result of a successful application", "type" : "string" }, "account_number_reservation_id" : { "description" : "Optional ID of an Account Reservation object that allocates an account number. By default, the account number is generated when a new account is created", "type" : "string" }, "account_product_id" : { "description" : "ID of an Account Product object that determines what kind of account is created. Filterable.", "type" : "string" }, "bankdata" : { "description" : "Optional arbitrary data that can be attached for the bank's use", "type" : "object" }, "business_application_id" : { "description" : "ID of the Business Application object for the business applying for the account. Only needed for business accounts. Filterable.", "type" : "string" }, "deposit_id" : { "description" : "ID of the Deposit object that defines the initial funding deposit for the new account", "type" : "string" }, "id" : { "description" : "Unique identifier for object", "type" : "string" }, "nickname" : { "description" : "Optional nickname for the account, for the user's reference", "type" : "string" }, "ownership_type" : { "description" : "One of: `business`, `personal`. Filterable.", "type" : "string" }, "person_applications" : { "description" : "Array of objects describing persons associated with this account application, including the primary person. Always `null` for business accounts", "items" : { "properties" : { "id" : { "description" : "Person application ID", "type" : "string" }, "roles" : { "description" : "List of applicant's special roles, if any. Valid roles are `owner`, `signer`, `minor`, `authorized_user`, and `debit_card_holder`. The `minor` role is used to indicate a person who is a beneficiary but not of legal age to be a signer", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "type" : "array" }, "primary_person_application_id" : { "description" : "ID of the Person Application object representing the primary person applicant. Filterable.", "type" : "string" }, "status" : { "description" : "One of: `unsubmitted`, `submitted`, `canceled`, `kyc`, `processing`, `manual_review`, `rejected`, or `approved`. Indicates the current status of the application as it is evaluated. Filterable.", "type" : "string" }, "userdata" : { "description" : "Optional arbitrary data the user can attach to the object", "type" : "object" } }, "type" : "object" }, "type" : "array" } } } } }, "description" : "A dictionary with a `data` property that contains a list of up to `page_size` account-application elements, starting after the account-application described by `page_cursor`. If no more account-applications are available, the resulting list will be empty." } }, "summary" : "List Account Applications", "tags" : [ "Account Application" ] }, "post" : { "requestBody" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Personal", "value" : { "account_product_id" : "apt_11gqk87qmrax", "deposit_id" : "adpt_01d5w6xx0tvs", "person_applications" : [ { "id" : "apsn_01d5w6yaa6vt", "roles" : [ "owner", "signer" ] } ], "primary_person_application_id" : "apsn_01d5w6yaa6vt" } } }, "schema" : { "properties" : { "account_number_reservation_id" : { "description" : "Optional ID of an Account Reservation object that allocates an account number. By default, the account number is generated when a new account is created", "type" : "string" }, "account_product_id" : { "description" : "ID of an Account Product object that determines what kind of account is created. Filterable.", "type" : "string" }, "bankdata" : { "description" : "Optional arbitrary data that can be attached for the bank's use", "type" : "object" }, "business_application_id" : { "description" : "ID of the Business Application object for the business applying for the account. Only needed for business accounts. Filterable.", "type" : "string" }, "deposit_id" : { "description" : "ID of the Deposit object that defines the initial funding deposit for the new account", "type" : "string" }, "nickname" : { "description" : "Optional nickname for the account, for the user's reference", "type" : "string" }, "person_applications" : { "description" : "Array of objects describing persons associated with this account application, including the primary person. Always `null` for business accounts", "items" : { "properties" : { "id" : { "description" : "Person application ID", "type" : "string" }, "roles" : { "description" : "List of applicant's special roles, if any. Valid roles are `owner`, `signer`, `minor`, `authorized_user`, and `debit_card_holder`. The `minor` role is used to indicate a person who is a beneficiary but not of legal age to be a signer", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "type" : "array" }, "primary_person_application_id" : { "description" : "ID of the Person Application object representing the primary person applicant. Filterable.", "type" : "string" }, "status" : { "description" : "One of: `unsubmitted`, `submitted`, `canceled`, `kyc`, `processing`, `manual_review`, `rejected`, or `approved`. Indicates the current status of the application as it is evaluated. Filterable.", "type" : "string" }, "userdata" : { "description" : "Optional arbitrary data the user can attach to the object", "type" : "object" } }, "required" : [ "account_product_id", "primary_person_application_id", "id" ] } } }, "description" : "The apply.account-application to create", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Personal", "value" : { "account_id" : null, "account_number_reservation_id" : null, "account_product_id" : "apt_11gqk87qmrax", "bankdata" : null, "business_application_id" : null, "created_at" : "2019-03-15T11:55:14Z", "deposit_id" : "adpt_01d5w6xx0tvs", "id" : "aact_01d5w6xb72vr", "person_applications" : [ { "id" : "apsn_01d5w6yaa6vt", "roles" : [ "owner", "signer" ] } ], "primary_person_application_id" : "apsn_01d5w6yaa6vt", "status" : "submitted", "updated_at" : "2019-03-15T11:55:14Z", "userdata" : null } } }, "schema" : { "properties" : { "account_id" : { "description" : "ID of the Account object that is created as a result of a successful application. Filterable.", "type" : "string" }, "account_number" : { "description" : "Account number associated with Account object that is created as a result of a successful application", "type" : "string" }, "account_number_reservation_id" : { "description" : "Optional ID of an Account Reservation object that allocates an account number. By default, the account number is generated when a new account is created", "type" : "string" }, "account_product_id" : { "description" : "ID of an Account Product object that determines what kind of account is created. Filterable.", "type" : "string" }, "bankdata" : { "description" : "Optional arbitrary data that can be attached for the bank's use", "type" : "object" }, "business_application_id" : { "description" : "ID of the Business Application object for the business applying for the account. Only needed for business accounts. Filterable.", "type" : "string" }, "deposit_id" : { "description" : "ID of the Deposit object that defines the initial funding deposit for the new account", "type" : "string" }, "id" : { "description" : "Unique identifier for object", "type" : "string" }, "nickname" : { "description" : "Optional nickname for the account, for the user's reference", "type" : "string" }, "ownership_type" : { "description" : "One of: `business`, `personal`. Filterable.", "type" : "string" }, "person_applications" : { "description" : "Array of objects describing persons associated with this account application, including the primary person. Always `null` for business accounts", "items" : { "properties" : { "id" : { "description" : "Person application ID", "type" : "string" }, "roles" : { "description" : "List of applicant's special roles, if any. Valid roles are `owner`, `signer`, `minor`, `authorized_user`, and `debit_card_holder`. The `minor` role is used to indicate a person who is a beneficiary but not of legal age to be a signer", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "type" : "array" }, "primary_person_application_id" : { "description" : "ID of the Person Application object representing the primary person applicant. Filterable.", "type" : "string" }, "status" : { "description" : "One of: `unsubmitted`, `submitted`, `canceled`, `kyc`, `processing`, `manual_review`, `rejected`, or `approved`. Indicates the current status of the application as it is evaluated. Filterable.", "type" : "string" }, "userdata" : { "description" : "Optional arbitrary data the user can attach to the object", "type" : "object" } } } } }, "description" : "The apply.account-application created" } }, "summary" : "Create an Account Application", "tags" : [ "Account Application" ] } }, "/apply/account_application/{id}" : { "get" : { "parameters" : [ { "description" : "Unique identifier for object", "in" : "path", "name" : "id", "required" : true, "schema" : { "description" : "Unique identifier for object", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Success", "value" : { "account_id" : null, "account_number_reservation_id" : null, "account_product_id" : "apt_11gqk87qmrax", "bankdata" : null, "business_application_id" : "abus_01dcrqkr3yhw", "created_at" : "2019-03-15T11:55:14Z", "deposit_id" : "adpt_01d5wgg8js", "id" : "aact_01jkw68sjab33", "person_applications" : [ ], "primary_person_application_id" : "apsn_01d5w6yaa6vt", "status" : "submitted", "updated_at" : "2019-03-15T11:55:14Z", "userdata" : null } } }, "schema" : { "properties" : { "account_id" : { "description" : "ID of the Account object that is created as a result of a successful application. Filterable.", "type" : "string" }, "account_number" : { "description" : "Account number associated with Account object that is created as a result of a successful application", "type" : "string" }, "account_number_reservation_id" : { "description" : "Optional ID of an Account Reservation object that allocates an account number. By default, the account number is generated when a new account is created", "type" : "string" }, "account_product_id" : { "description" : "ID of an Account Product object that determines what kind of account is created. Filterable.", "type" : "string" }, "bankdata" : { "description" : "Optional arbitrary data that can be attached for the bank's use", "type" : "object" }, "business_application_id" : { "description" : "ID of the Business Application object for the business applying for the account. Only needed for business accounts. Filterable.", "type" : "string" }, "deposit_id" : { "description" : "ID of the Deposit object that defines the initial funding deposit for the new account", "type" : "string" }, "id" : { "description" : "Unique identifier for object", "type" : "string" }, "nickname" : { "description" : "Optional nickname for the account, for the user's reference", "type" : "string" }, "ownership_type" : { "description" : "One of: `business`, `personal`. Filterable.", "type" : "string" }, "person_applications" : { "description" : "Array of objects describing persons associated with this account application, including the primary person. Always `null` for business accounts", "items" : { "properties" : { "id" : { "description" : "Person application ID", "type" : "string" }, "roles" : { "description" : "List of applicant's special roles, if any. Valid roles are `owner`, `signer`, `minor`, `authorized_user`, and `debit_card_holder`. The `minor` role is used to indicate a person who is a beneficiary but not of legal age to be a signer", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "type" : "array" }, "primary_person_application_id" : { "description" : "ID of the Person Application object representing the primary person applicant. Filterable.", "type" : "string" }, "status" : { "description" : "One of: `unsubmitted`, `submitted`, `canceled`, `kyc`, `processing`, `manual_review`, `rejected`, or `approved`. Indicates the current status of the application as it is evaluated. Filterable.", "type" : "string" }, "userdata" : { "description" : "Optional arbitrary data the user can attach to the object", "type" : "object" } } } } }, "description" : "The apply.account-application" } }, "summary" : "Fetch an Account Application", "tags" : [ "Account Application" ] } }, "/apply/additional_person_application" : { "get" : { "parameters" : [ { "description" : "ID of the Account to add an additional person. Filterable.", "in" : "query", "name" : "account_id", "schema" : { "type" : "string" } }, { "description" : "ID of the Person Application to associate with the Account. Filterable.", "in" : "query", "name" : "person_application_id", "schema" : { "type" : "string" } }, { "description" : "Role to use when associating the Person Application with the Account. Filterable.", "in" : "query", "name" : "role", "schema" : { "type" : "string" } }, { "description" : "Status of the additional person application. One of `approved`, `error`, `pending`, `processing`, `rejected`, `manual_review`. Filterable.", "in" : "query", "name" : "status", "schema" : { "type" : "string" } }, { "description" : "Pagination cursor, value is the object ID.", "in" : "query", "name" : "page_cursor", "schema" : { "type" : "string" } }, { "description" : "Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.", "in" : "query", "name" : "page_size", "schema" : { "default" : 100, "minimum" : 1, "type" : "integer" } }, { "description" : "Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in" : "query", "name" : "from_date", "schema" : { "type" : "string" } }, { "description" : "Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in" : "query", "name" : "to_date", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Success", "value" : { "data" : [ { "account_id" : "acct_11fnfr2p45f96m", "bankdata" : { "ip_address" : "127.0.0.40" }, "created_at" : "2019-03-02T11:55:14Z", "id" : "aapa_01d5w7mvmwvy", "person_application_id" : "apsn_01d5w7mvmwvy", "role" : "owner", "status" : "pending", "updated_at" : "2019-03-02T11:55:14Z", "userdata" : null } ] } } }, "schema" : { "properties" : { "data" : { "items" : { "properties" : { "account_id" : { "description" : "ID of the Account to add an additional person. Filterable.", "type" : "string" }, "bankdata" : { "description" : "Arbitrary data attached to the object, for the bank's use", "type" : "object" }, "id" : { "description" : "Unique identifier for the object", "type" : "string" }, "person_application_id" : { "description" : "ID of the Person Application to associate with the Account. Filterable.", "type" : "string" }, "role" : { "description" : "Role to use when associating the Person Application with the Account. Filterable.", "type" : "string" }, "status" : { "description" : "Status of the additional person application. One of `approved`, `error`, `pending`, `processing`, `rejected`, `manual_review`. Filterable.", "type" : "string" }, "userdata" : { "description" : "Arbitrary data the user can attach to the object", "type" : "object" } }, "type" : "object" }, "type" : "array" } } } } }, "description" : "A dictionary with a `data` property that contains a list of up to `page_size` additional-person-application elements, starting after the additional-person-application described by `page_cursor`. If no more additional-person-applications are available, the resulting list will be empty." } }, "summary" : "List Additional Person Applications", "tags" : [ "Additional Person" ] }, "post" : { "requestBody" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Success", "value" : { "bankdata" : { "ip_address" : "127.0.0.40" }, "person_application_id" : "apsn_01d5w7mvmwvy", "role" : "owner" } } }, "schema" : { "properties" : { "account_id" : { "description" : "ID of the Account to add an additional person. Filterable.", "type" : "string" }, "bankdata" : { "description" : "Arbitrary data attached to the object, for the bank's use", "type" : "object" }, "person_application_id" : { "description" : "ID of the Person Application to associate with the Account. Filterable.", "type" : "string" }, "role" : { "description" : "Role to use when associating the Person Application with the Account. Filterable.", "type" : "string" }, "userdata" : { "description" : "Arbitrary data the user can attach to the object", "type" : "object" } }, "required" : [ "role", "account_id", "id", "person_application_id" ] } } }, "description" : "The apply.additional-person-application to create", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Success", "value" : { "account_id" : "acct_11fnfr2p45f96m", "bankdata" : { "ip_address" : "127.0.0.40" }, "created_at" : "2019-03-02T11:55:14Z", "id" : "aapa_01d5w7mvmwvy", "person_application_id" : "apsn_01d5w7mvmwvy", "role" : "owner", "status" : "pending", "updated_at" : "2019-03-02T11:55:14Z", "userdata" : null } } }, "schema" : { "properties" : { "account_id" : { "description" : "ID of the Account to add an additional person. Filterable.", "type" : "string" }, "bankdata" : { "description" : "Arbitrary data attached to the object, for the bank's use", "type" : "object" }, "id" : { "description" : "Unique identifier for the object", "type" : "string" }, "person_application_id" : { "description" : "ID of the Person Application to associate with the Account. Filterable.", "type" : "string" }, "role" : { "description" : "Role to use when associating the Person Application with the Account. Filterable.", "type" : "string" }, "status" : { "description" : "Status of the additional person application. One of `approved`, `error`, `pending`, `processing`, `rejected`, `manual_review`. Filterable.", "type" : "string" }, "userdata" : { "description" : "Arbitrary data the user can attach to the object", "type" : "object" } } } } }, "description" : "The apply.additional-person-application created" } }, "summary" : "Create an Additional Person Application", "tags" : [ "Additional Person" ] } }, "/apply/additional_person_application/{id}" : { "get" : { "parameters" : [ { "description" : "Unique identifier for the object", "in" : "path", "name" : "id", "required" : true, "schema" : { "description" : "Unique identifier for the object", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Success", "value" : { "account_id" : "acct_11fnfr2p45f96m", "bankdata" : { "ip_address" : "127.0.0.40" }, "created_at" : "2019-03-02T11:55:14Z", "id" : "aapa_01d5w7mvmwvy", "person_application_id" : "apsn_01d5w7mvmwvy", "role" : "owner", "status" : "pending", "updated_at" : "2019-03-02T11:55:14Z", "userdata" : null } } }, "schema" : { "properties" : { "account_id" : { "description" : "ID of the Account to add an additional person. Filterable.", "type" : "string" }, "bankdata" : { "description" : "Arbitrary data attached to the object, for the bank's use", "type" : "object" }, "id" : { "description" : "Unique identifier for the object", "type" : "string" }, "person_application_id" : { "description" : "ID of the Person Application to associate with the Account. Filterable.", "type" : "string" }, "role" : { "description" : "Role to use when associating the Person Application with the Account. Filterable.", "type" : "string" }, "status" : { "description" : "Status of the additional person application. One of `approved`, `error`, `pending`, `processing`, `rejected`, `manual_review`. Filterable.", "type" : "string" }, "userdata" : { "description" : "Arbitrary data the user can attach to the object", "type" : "object" } } } } }, "description" : "The apply.additional-person-application" } }, "summary" : "Fetch an Additional Person Application", "tags" : [ "Additional Person" ] } }, "/apply/business_application" : { "get" : { "parameters" : [ { "description" : "Pagination cursor, value is the object ID.", "in" : "query", "name" : "page_cursor", "schema" : { "type" : "string" } }, { "description" : "Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.", "in" : "query", "name" : "page_size", "schema" : { "default" : 100, "minimum" : 1, "type" : "integer" } }, { "description" : "Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in" : "query", "name" : "from_date", "schema" : { "type" : "string" } }, { "description" : "Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in" : "query", "name" : "to_date", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Success", "value" : { "data" : [ { "bank_id" : "bank_anybank", "bankdata" : null, "created_at" : "2019-03-02T11:55:14Z", "dba" : null, "description" : "Our company is engaged in the buying and selling of [...]", "established_on" : "2018-08-01", "id" : "abus_21sen7m398ab", "identification_number" : null, "identification_number_type" : null, "incorporation_state" : "DE", "legal_structure" : "llc", "mailing_address" : { "city" : "Sacramento", "country" : "US", "postal_code" : "95814", "state" : "CA", "street_line_1" : "1300 L St" }, "naics" : "42", "naics_description" : "Wholesale Trade", "name" : "Acme Goods Inc", "person_applications" : [ { "id" : "apsn_01d5w6yaa6vt", "ownership_percentage" : 25, "roles" : [ "signer" ], "title" : "CEO" }, { "id" : "apsn_0fd62018smsk", "ownership_percentage" : 30, "roles" : [ "control_person", "signer" ], "title" : "CFO" } ], "phone_number" : "+1 415-555-1111", "physical_address" : { "city" : "Benicia", "postal_code" : "94510", "state" : "CA", "street_line_1" : "115 W G St" }, "tin" : "11-3344555", "updated_at" : "2019-03-02T11:55:14Z", "urls" : [ "http://example.com" ], "userdata" : null } ] } } }, "schema" : { "properties" : { "data" : { "items" : { "properties" : { "bank_id" : { "description" : "ID of the bank with which the object is associated", "type" : "string" }, "bankdata" : { "description" : "Optional arbitrary data that can be attached for the bank's use", "type" : "object" }, "dba" : { "description" : "Alternate 'Doing Business As' name of the business, if it has one", "type" : "string" }, "description" : { "description" : "Description of the business", "type" : "string" }, "document_ids" : { "description" : "Array of Document IDs pertaining to this business", "items" : { "type" : "string" }, "type" : "array" }, "established_on" : { "description" : "Date that the business was established, ISO 8601 format ('YYYY-MM-DD')", "type" : "string" }, "id" : { "description" : "Unique identifier for object", "type" : "string" }, "identification_number" : { "description" : "International identification number (max of 30 characters)", "type" : "string" }, "identification_number_type" : { "description" : "Type of international identification number (max of 30 characters)", "type" : "string" }, "incorporation_state" : { "description" : "State (max 2 characters for US, max 3 characters for other countries)", "type" : "string" }, "is_publicly_traded" : { "description" : "Whether the business is a publicly traded entity. Null value means its trading status is unknown.", "type" : "boolean" }, "legal_structure" : { "description" : "How the business is legally structured: one of `ccorp`, `corp`, `estate`, `foreign_entity`, `llc`, `llp`, `lp`, `nonprofit`, `partnership`, `scorp`, `soleprop`, `trust`, or `municipality`", "type" : "string" }, "mailing_address" : { "description" : "Object describing the mailing address of the business", "properties" : { "city" : { "description" : "City (max 18 characters)", "type" : "string" }, "country" : { "description" : "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type" : "string" }, "postal_code" : { "description" : "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type" : "string" }, "state" : { "description" : "State (max 2 characters for US, max 3 characters for other countries)", "type" : "string" }, "street_line_1" : { "description" : "First line of the address (max 35 characters)", "type" : "string" }, "street_line_2" : { "description" : "Optional second line of the address (max 35 characters)", "type" : "string" } }, "type" : "object" }, "naics" : { "description" : "NAICS sector code that describes the industry in which the business operates", "type" : "string" }, "naics_description" : { "description" : "NAICS sector description matching the above NAICS sector code. If 'Other', please use an industry description prefixed with 'Other: '", "type" : "string" }, "name" : { "description" : "Name of the business", "type" : "string" }, "org_id" : { "description" : "ID of the organization with which the object is associated", "type" : "string" }, "parent_businesses" : { "deprecated" : true, "description" : "Array of business IDs pertaining to this business", "items" : { "properties" : { "id" : { "description" : "Parent business application ID", "type" : "string" }, "ownership_percentage" : { "description" : "Ownership percentage of the parent business", "type" : "integer" } }, "type" : "object" }, "type" : "array" }, "person_applications" : { "description" : "Array of objects describing person applications associated with this business", "items" : { "properties" : { "id" : { "description" : "Person application ID", "type" : "string" }, "ownership_percentage" : { "description" : "The person's ownership interest in the business, represented as an integer from 0 to 100", "type" : "integer" }, "roles" : { "description" : "List of applicant's roles, if applicable. Valid roles are `signer`, `control_person`, and `debit_card_holder`", "items" : { "type" : "string" }, "type" : "array" }, "title" : { "description" : "Title of the person within the business (e.g. 'Owner', 'CEO', 'Treasurer')", "type" : "string" } }, "type" : "object" }, "type" : "array" }, "phone_number" : { "description" : "Phone number of the business", "type" : "string" }, "physical_address" : { "description" : "Object describing the physical address of the business", "properties" : { "city" : { "description" : "City (max 18 characters)", "type" : "string" }, "country" : { "description" : "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type" : "string" }, "postal_code" : { "description" : "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type" : "string" }, "state" : { "description" : "State (max 2 characters for US, max 3 characters for other countries)", "type" : "string" }, "street_line_1" : { "description" : "First line of the address (max 35 characters)", "type" : "string" }, "street_line_2" : { "description" : "Optional second line of the address (max 35 characters)", "type" : "string" } }, "type" : "object" }, "tin" : { "description" : "Tax identification number (EIN or other tax ID) for U.S. businesses", "type" : "string" }, "urls" : { "description" : "URLs for the business website(s)", "items" : { "type" : "string" }, "type" : "array" }, "userdata" : { "description" : "Arbitrary data the user can attach to the object", "type" : "object" } }, "type" : "object" }, "type" : "array" } } } } }, "description" : "A dictionary with a `data` property that contains a list of up to `page_size` business-application elements, starting after the business-application described by `page_cursor`. If no more business-applications are available, the resulting list will be empty." } }, "summary" : "List Business Applications", "tags" : [ "Business Application" ] }, "post" : { "requestBody" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Success", "value" : { "dba" : null, "description" : "Our company is engaged in the buying and selling of [...]", "established_on" : "2018-08-01", "identification_number" : null, "identification_number_type" : null, "incorporation_state" : "DE", "legal_structure" : "llc", "mailing_address" : { "city" : "Sacramento", "country" : "US", "postal_code" : "95814", "state" : "CA", "street_line_1" : "1300 L St" }, "naics" : "42", "naics_description" : "Wholesale Trade", "name" : "Acme Goods Inc", "person_applications" : [ { "id" : "apsn_01d5w6yaa6vt", "ownership_percentage" : 25, "roles" : [ "signer" ], "title" : "CEO" }, { "id" : "apsn_0fd62018smsk", "ownership_percentage" : 30, "roles" : [ "control_person", "signer" ], "title" : "CFO" } ], "phone_number" : "+1 415-555-1111", "physical_address" : { "city" : "Benicia", "postal_code" : "94510", "state" : "CA", "street_line_1" : "115 W G St" }, "tin" : "11-3344555", "urls" : [ "http://example.com" ] } } }, "schema" : { "properties" : { "bankdata" : { "description" : "Optional arbitrary data that can be attached for the bank's use", "type" : "object" }, "dba" : { "description" : "Alternate 'Doing Business As' name of the business, if it has one", "type" : "string" }, "description" : { "description" : "Description of the business", "type" : "string" }, "document_ids" : { "description" : "Array of Document IDs pertaining to this business", "items" : { "type" : "string" }, "type" : "array" }, "established_on" : { "description" : "Date that the business was established, ISO 8601 format ('YYYY-MM-DD')", "type" : "string" }, "identification_number" : { "description" : "International identification number (max of 30 characters)", "type" : "string" }, "identification_number_type" : { "description" : "Type of international identification number (max of 30 characters)", "type" : "string" }, "incorporation_state" : { "description" : "State (max 2 characters for US, max 3 characters for other countries)", "type" : "string" }, "is_publicly_traded" : { "description" : "Whether the business is a publicly traded entity. Null value means its trading status is unknown.", "type" : "boolean" }, "legal_structure" : { "description" : "How the business is legally structured: one of `ccorp`, `corp`, `estate`, `foreign_entity`, `llc`, `llp`, `lp`, `nonprofit`, `partnership`, `scorp`, `soleprop`, `trust`, or `municipality`", "type" : "string" }, "mailing_address" : { "description" : "Object describing the mailing address of the business", "properties" : { "city" : { "description" : "City (max 18 characters)", "type" : "string" }, "country" : { "description" : "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type" : "string" }, "postal_code" : { "description" : "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type" : "string" }, "state" : { "description" : "State (max 2 characters for US, max 3 characters for other countries)", "type" : "string" }, "street_line_1" : { "description" : "First line of the address (max 35 characters)", "type" : "string" }, "street_line_2" : { "description" : "Optional second line of the address (max 35 characters)", "type" : "string" } }, "type" : "object" }, "naics" : { "description" : "NAICS sector code that describes the industry in which the business operates", "type" : "string" }, "naics_description" : { "description" : "NAICS sector description matching the above NAICS sector code. If 'Other', please use an industry description prefixed with 'Other: '", "type" : "string" }, "name" : { "description" : "Name of the business", "type" : "string" }, "parent_businesses" : { "deprecated" : true, "description" : "Array of business IDs pertaining to this business", "items" : { "properties" : { "id" : { "description" : "Parent business application ID", "type" : "string" }, "ownership_percentage" : { "description" : "Ownership percentage of the parent business", "type" : "integer" } }, "type" : "object" }, "type" : "array" }, "person_applications" : { "description" : "Array of objects describing person applications associated with this business", "items" : { "properties" : { "id" : { "description" : "Person application ID", "type" : "string" }, "ownership_percentage" : { "description" : "The person's ownership interest in the business, represented as an integer from 0 to 100", "type" : "integer" }, "roles" : { "description" : "List of applicant's roles, if applicable. Valid roles are `signer`, `control_person`, and `debit_card_holder`", "items" : { "type" : "string" }, "type" : "array" }, "title" : { "description" : "Title of the person within the business (e.g. 'Owner', 'CEO', 'Treasurer')", "type" : "string" } }, "type" : "object" }, "type" : "array" }, "phone_number" : { "description" : "Phone number of the business", "type" : "string" }, "physical_address" : { "description" : "Object describing the physical address of the business", "properties" : { "city" : { "description" : "City (max 18 characters)", "type" : "string" }, "country" : { "description" : "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type" : "string" }, "postal_code" : { "description" : "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type" : "string" }, "state" : { "description" : "State (max 2 characters for US, max 3 characters for other countries)", "type" : "string" }, "street_line_1" : { "description" : "First line of the address (max 35 characters)", "type" : "string" }, "street_line_2" : { "description" : "Optional second line of the address (max 35 characters)", "type" : "string" } }, "type" : "object" }, "tin" : { "description" : "Tax identification number (EIN or other tax ID) for U.S. businesses", "type" : "string" }, "urls" : { "description" : "URLs for the business website(s)", "items" : { "type" : "string" }, "type" : "array" }, "userdata" : { "description" : "Arbitrary data the user can attach to the object", "type" : "object" } }, "required" : [ "legal_structure", "name", "physical_address", "id", "person_applications" ] } } }, "description" : "The apply.business-application to create", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Success", "value" : { "bank_id" : "bank_anybank", "bankdata" : null, "created_at" : "2019-03-02T11:55:14Z", "dba" : null, "description" : "Our company is engaged in the buying and selling of [...]", "established_on" : "2018-08-01", "id" : "abus_21sen7m398ab", "identification_number" : null, "identification_number_type" : null, "incorporation_state" : "DE", "legal_structure" : "llc", "mailing_address" : { "city" : "Sacramento", "country" : "US", "postal_code" : "95814", "state" : "CA", "street_line_1" : "1300 L St" }, "naics" : "42", "naics_description" : "Wholesale Trade", "name" : "Acme Goods Inc", "person_applications" : [ { "id" : "apsn_01d5w6yaa6vt", "ownership_percentage" : 25, "roles" : [ "signer" ], "title" : "CEO" }, { "id" : "apsn_0fd62018smsk", "ownership_percentage" : 30, "roles" : [ "control_person", "signer" ], "title" : "CFO" } ], "phone_number" : "+1 415-555-1111", "physical_address" : { "city" : "Benicia", "postal_code" : "94510", "state" : "CA", "street_line_1" : "115 W G St" }, "tin" : "11-3344555", "updated_at" : "2019-03-02T11:55:14Z", "urls" : [ "http://example.com" ], "userdata" : null } } }, "schema" : { "properties" : { "bank_id" : { "description" : "ID of the bank with which the object is associated", "type" : "string" }, "bankdata" : { "description" : "Optional arbitrary data that can be attached for the bank's use", "type" : "object" }, "dba" : { "description" : "Alternate 'Doing Business As' name of the business, if it has one", "type" : "string" }, "description" : { "description" : "Description of the business", "type" : "string" }, "document_ids" : { "description" : "Array of Document IDs pertaining to this business", "items" : { "type" : "string" }, "type" : "array" }, "established_on" : { "description" : "Date that the business was established, ISO 8601 format ('YYYY-MM-DD')", "type" : "string" }, "id" : { "description" : "Unique identifier for object", "type" : "string" }, "identification_number" : { "description" : "International identification number (max of 30 characters)", "type" : "string" }, "identification_number_type" : { "description" : "Type of international identification number (max of 30 characters)", "type" : "string" }, "incorporation_state" : { "description" : "State (max 2 characters for US, max 3 characters for other countries)", "type" : "string" }, "is_publicly_traded" : { "description" : "Whether the business is a publicly traded entity. Null value means its trading status is unknown.", "type" : "boolean" }, "legal_structure" : { "description" : "How the business is legally structured: one of `ccorp`, `corp`, `estate`, `foreign_entity`, `llc`, `llp`, `lp`, `nonprofit`, `partnership`, `scorp`, `soleprop`, `trust`, or `municipality`", "type" : "string" }, "mailing_address" : { "description" : "Object describing the mailing address of the business", "properties" : { "city" : { "description" : "City (max 18 characters)", "type" : "string" }, "country" : { "description" : "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type" : "string" }, "postal_code" : { "description" : "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type" : "string" }, "state" : { "description" : "State (max 2 characters for US, max 3 characters for other countries)", "type" : "string" }, "street_line_1" : { "description" : "First line of the address (max 35 characters)", "type" : "string" }, "street_line_2" : { "description" : "Optional second line of the address (max 35 characters)", "type" : "string" } }, "type" : "object" }, "naics" : { "description" : "NAICS sector code that describes the industry in which the business operates", "type" : "string" }, "naics_description" : { "description" : "NAICS sector description matching the above NAICS sector code. If 'Other', please use an industry description prefixed with 'Other: '", "type" : "string" }, "name" : { "description" : "Name of the business", "type" : "string" }, "org_id" : { "description" : "ID of the organization with which the object is associated", "type" : "string" }, "parent_businesses" : { "deprecated" : true, "description" : "Array of business IDs pertaining to this business", "items" : { "properties" : { "id" : { "description" : "Parent business application ID", "type" : "string" }, "ownership_percentage" : { "description" : "Ownership percentage of the parent business", "type" : "integer" } }, "type" : "object" }, "type" : "array" }, "person_applications" : { "description" : "Array of objects describing person applications associated with this business", "items" : { "properties" : { "id" : { "description" : "Person application ID", "type" : "string" }, "ownership_percentage" : { "description" : "The person's ownership interest in the business, represented as an integer from 0 to 100", "type" : "integer" }, "roles" : { "description" : "List of applicant's roles, if applicable. Valid roles are `signer`, `control_person`, and `debit_card_holder`", "items" : { "type" : "string" }, "type" : "array" }, "title" : { "description" : "Title of the person within the business (e.g. 'Owner', 'CEO', 'Treasurer')", "type" : "string" } }, "type" : "object" }, "type" : "array" }, "phone_number" : { "description" : "Phone number of the business", "type" : "string" }, "physical_address" : { "description" : "Object describing the physical address of the business", "properties" : { "city" : { "description" : "City (max 18 characters)", "type" : "string" }, "country" : { "description" : "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type" : "string" }, "postal_code" : { "description" : "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type" : "string" }, "state" : { "description" : "State (max 2 characters for US, max 3 characters for other countries)", "type" : "string" }, "street_line_1" : { "description" : "First line of the address (max 35 characters)", "type" : "string" }, "street_line_2" : { "description" : "Optional second line of the address (max 35 characters)", "type" : "string" } }, "type" : "object" }, "tin" : { "description" : "Tax identification number (EIN or other tax ID) for U.S. businesses", "type" : "string" }, "urls" : { "description" : "URLs for the business website(s)", "items" : { "type" : "string" }, "type" : "array" }, "userdata" : { "description" : "Arbitrary data the user can attach to the object", "type" : "object" } } } } }, "description" : "The apply.business-application created" } }, "summary" : "Create a Business Application", "tags" : [ "Business Application" ] } }, "/apply/business_application/{id}" : { "get" : { "parameters" : [ { "description" : "Unique identifier for object", "in" : "path", "name" : "id", "required" : true, "schema" : { "description" : "Unique identifier for object", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Success", "value" : { "bank_id" : "bank_anybank", "bankdata" : null, "created_at" : "2019-03-02T11:55:14Z", "dba" : null, "description" : "Our company is engaged in the buying and selling of [...]", "established_on" : "2018-08-01", "id" : "abus_21sen7m398ab", "identification_number" : null, "identification_number_type" : null, "incorporation_state" : "DE", "legal_structure" : "llc", "mailing_address" : { "city" : "Sacramento", "country" : "US", "postal_code" : "95814", "state" : "CA", "street_line_1" : "1300 L St" }, "naics" : "42", "naics_description" : "Wholesale Trade", "name" : "Acme Goods Inc", "person_applications" : [ { "id" : "apsn_01d5w6yaa6vt", "ownership_percentage" : 25, "roles" : [ "signer" ], "title" : "CEO" }, { "id" : "apsn_0fd62018smsk", "ownership_percentage" : 30, "roles" : [ "control_person", "signer" ], "title" : "CFO" } ], "phone_number" : "+1 415-555-1111", "physical_address" : { "city" : "Benicia", "postal_code" : "94510", "state" : "CA", "street_line_1" : "115 W G St" }, "tin" : "11-3344555", "updated_at" : "2019-03-02T11:55:14Z", "urls" : [ "http://example.com" ], "userdata" : null } } }, "schema" : { "properties" : { "bank_id" : { "description" : "ID of the bank with which the object is associated", "type" : "string" }, "bankdata" : { "description" : "Optional arbitrary data that can be attached for the bank's use", "type" : "object" }, "dba" : { "description" : "Alternate 'Doing Business As' name of the business, if it has one", "type" : "string" }, "description" : { "description" : "Description of the business", "type" : "string" }, "document_ids" : { "description" : "Array of Document IDs pertaining to this business", "items" : { "type" : "string" }, "type" : "array" }, "established_on" : { "description" : "Date that the business was established, ISO 8601 format ('YYYY-MM-DD')", "type" : "string" }, "id" : { "description" : "Unique identifier for object", "type" : "string" }, "identification_number" : { "description" : "International identification number (max of 30 characters)", "type" : "string" }, "identification_number_type" : { "description" : "Type of international identification number (max of 30 characters)", "type" : "string" }, "incorporation_state" : { "description" : "State (max 2 characters for US, max 3 characters for other countries)", "type" : "string" }, "is_publicly_traded" : { "description" : "Whether the business is a publicly traded entity. Null value means its trading status is unknown.", "type" : "boolean" }, "legal_structure" : { "description" : "How the business is legally structured: one of `ccorp`, `corp`, `estate`, `foreign_entity`, `llc`, `llp`, `lp`, `nonprofit`, `partnership`, `scorp`, `soleprop`, `trust`, or `municipality`", "type" : "string" }, "mailing_address" : { "description" : "Object describing the mailing address of the business", "properties" : { "city" : { "description" : "City (max 18 characters)", "type" : "string" }, "country" : { "description" : "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type" : "string" }, "postal_code" : { "description" : "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type" : "string" }, "state" : { "description" : "State (max 2 characters for US, max 3 characters for other countries)", "type" : "string" }, "street_line_1" : { "description" : "First line of the address (max 35 characters)", "type" : "string" }, "street_line_2" : { "description" : "Optional second line of the address (max 35 characters)", "type" : "string" } }, "type" : "object" }, "naics" : { "description" : "NAICS sector code that describes the industry in which the business operates", "type" : "string" }, "naics_description" : { "description" : "NAICS sector description matching the above NAICS sector code. If 'Other', please use an industry description prefixed with 'Other: '", "type" : "string" }, "name" : { "description" : "Name of the business", "type" : "string" }, "org_id" : { "description" : "ID of the organization with which the object is associated", "type" : "string" }, "parent_businesses" : { "deprecated" : true, "description" : "Array of business IDs pertaining to this business", "items" : { "properties" : { "id" : { "description" : "Parent business application ID", "type" : "string" }, "ownership_percentage" : { "description" : "Ownership percentage of the parent business", "type" : "integer" } }, "type" : "object" }, "type" : "array" }, "person_applications" : { "description" : "Array of objects describing person applications associated with this business", "items" : { "properties" : { "id" : { "description" : "Person application ID", "type" : "string" }, "ownership_percentage" : { "description" : "The person's ownership interest in the business, represented as an integer from 0 to 100", "type" : "integer" }, "roles" : { "description" : "List of applicant's roles, if applicable. Valid roles are `signer`, `control_person`, and `debit_card_holder`", "items" : { "type" : "string" }, "type" : "array" }, "title" : { "description" : "Title of the person within the business (e.g. 'Owner', 'CEO', 'Treasurer')", "type" : "string" } }, "type" : "object" }, "type" : "array" }, "phone_number" : { "description" : "Phone number of the business", "type" : "string" }, "physical_address" : { "description" : "Object describing the physical address of the business", "properties" : { "city" : { "description" : "City (max 18 characters)", "type" : "string" }, "country" : { "description" : "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type" : "string" }, "postal_code" : { "description" : "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type" : "string" }, "state" : { "description" : "State (max 2 characters for US, max 3 characters for other countries)", "type" : "string" }, "street_line_1" : { "description" : "First line of the address (max 35 characters)", "type" : "string" }, "street_line_2" : { "description" : "Optional second line of the address (max 35 characters)", "type" : "string" } }, "type" : "object" }, "tin" : { "description" : "Tax identification number (EIN or other tax ID) for U.S. businesses", "type" : "string" }, "urls" : { "description" : "URLs for the business website(s)", "items" : { "type" : "string" }, "type" : "array" }, "userdata" : { "description" : "Arbitrary data the user can attach to the object", "type" : "object" } } } } }, "description" : "The apply.business-application" } }, "summary" : "Fetch a Business Application", "tags" : [ "Business Application" ] }, "patch" : { "parameters" : [ { "description" : "Unique identifier for object", "in" : "path", "name" : "id", "required" : true, "schema" : { "description" : "Unique identifier for object", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Update phone number", "value" : { "phone_number" : "4155552222" } } }, "schema" : { "properties" : { "bankdata" : { "description" : "Optional arbitrary data that can be attached for the bank's use", "type" : "object" }, "dba" : { "description" : "Alternate 'Doing Business As' name of the business, if it has one", "type" : "string" }, "description" : { "description" : "Description of the business", "type" : "string" }, "document_ids" : { "description" : "Array of Document IDs pertaining to this business", "items" : { "type" : "string" }, "type" : "array" }, "established_on" : { "description" : "Date that the business was established, ISO 8601 format ('YYYY-MM-DD')", "type" : "string" }, "identification_number" : { "description" : "International identification number (max of 30 characters)", "type" : "string" }, "identification_number_type" : { "description" : "Type of international identification number (max of 30 characters)", "type" : "string" }, "incorporation_state" : { "description" : "State (max 2 characters for US, max 3 characters for other countries)", "type" : "string" }, "is_publicly_traded" : { "description" : "Whether the business is a publicly traded entity. Null value means its trading status is unknown.", "type" : "boolean" }, "legal_structure" : { "description" : "How the business is legally structured: one of `ccorp`, `corp`, `estate`, `foreign_entity`, `llc`, `llp`, `lp`, `nonprofit`, `partnership`, `scorp`, `soleprop`, `trust`, or `municipality`", "type" : "string" }, "mailing_address" : { "description" : "Object describing the mailing address of the business", "properties" : { "city" : { "description" : "City (max 18 characters)", "type" : "string" }, "country" : { "description" : "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type" : "string" }, "postal_code" : { "description" : "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type" : "string" }, "state" : { "description" : "State (max 2 characters for US, max 3 characters for other countries)", "type" : "string" }, "street_line_1" : { "description" : "First line of the address (max 35 characters)", "type" : "string" }, "street_line_2" : { "description" : "Optional second line of the address (max 35 characters)", "type" : "string" } }, "type" : "object" }, "naics" : { "description" : "NAICS sector code that describes the industry in which the business operates", "type" : "string" }, "naics_description" : { "description" : "NAICS sector description matching the above NAICS sector code. If 'Other', please use an industry description prefixed with 'Other: '", "type" : "string" }, "name" : { "description" : "Name of the business", "type" : "string" }, "parent_businesses" : { "deprecated" : true, "description" : "Array of business IDs pertaining to this business", "items" : { "properties" : { "id" : { "description" : "Parent business application ID", "type" : "string" }, "ownership_percentage" : { "description" : "Ownership percentage of the parent business", "type" : "integer" } }, "type" : "object" }, "type" : "array" }, "person_applications" : { "description" : "Array of objects describing person applications associated with this business", "items" : { "properties" : { "id" : { "description" : "Person application ID", "type" : "string" }, "ownership_percentage" : { "description" : "The person's ownership interest in the business, represented as an integer from 0 to 100", "type" : "integer" }, "roles" : { "description" : "List of applicant's roles, if applicable. Valid roles are `signer`, `control_person`, and `debit_card_holder`", "items" : { "type" : "string" }, "type" : "array" }, "title" : { "description" : "Title of the person within the business (e.g. 'Owner', 'CEO', 'Treasurer')", "type" : "string" } }, "type" : "object" }, "type" : "array" }, "phone_number" : { "description" : "Phone number of the business", "type" : "string" }, "physical_address" : { "description" : "Object describing the physical address of the business", "properties" : { "city" : { "description" : "City (max 18 characters)", "type" : "string" }, "country" : { "description" : "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type" : "string" }, "postal_code" : { "description" : "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type" : "string" }, "state" : { "description" : "State (max 2 characters for US, max 3 characters for other countries)", "type" : "string" }, "street_line_1" : { "description" : "First line of the address (max 35 characters)", "type" : "string" }, "street_line_2" : { "description" : "Optional second line of the address (max 35 characters)", "type" : "string" } }, "type" : "object" }, "tin" : { "description" : "Tax identification number (EIN or other tax ID) for U.S. businesses", "type" : "string" }, "urls" : { "description" : "URLs for the business website(s)", "items" : { "type" : "string" }, "type" : "array" }, "userdata" : { "description" : "Arbitrary data the user can attach to the object", "type" : "object" } } } } }, "description" : "The apply.business-application to update", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Success", "value" : { "bank_id" : "bank_anybank", "bankdata" : null, "created_at" : "2019-03-02T11:55:14Z", "dba" : null, "description" : "Our company is engaged in the buying and selling of [...]", "established_on" : "2018-08-01", "id" : "abus_21sen7m398ab", "identification_number" : null, "identification_number_type" : null, "incorporation_state" : "DE", "legal_structure" : "llc", "mailing_address" : { "city" : "Sacramento", "country" : "US", "postal_code" : "95814", "state" : "CA", "street_line_1" : "1300 L St" }, "naics" : "42", "naics_description" : "Wholesale Trade", "name" : "Acme Goods Inc", "person_applications" : [ { "id" : "apsn_01d5w6yaa6vt", "ownership_percentage" : 25, "roles" : [ "signer" ], "title" : "CEO" }, { "id" : "apsn_0fd62018smsk", "ownership_percentage" : 30, "roles" : [ "control_person", "signer" ], "title" : "CFO" } ], "phone_number" : "4155552222", "physical_address" : { "city" : "Benicia", "postal_code" : "94510", "state" : "CA", "street_line_1" : "115 W G St" }, "tin" : "11-3344555", "updated_at" : "2019-03-02T11:55:14Z", "urls" : [ "http://example.com" ], "userdata" : null } } }, "schema" : { "properties" : { "bank_id" : { "description" : "ID of the bank with which the object is associated", "type" : "string" }, "bankdata" : { "description" : "Optional arbitrary data that can be attached for the bank's use", "type" : "object" }, "dba" : { "description" : "Alternate 'Doing Business As' name of the business, if it has one", "type" : "string" }, "description" : { "description" : "Description of the business", "type" : "string" }, "document_ids" : { "description" : "Array of Document IDs pertaining to this business", "items" : { "type" : "string" }, "type" : "array" }, "established_on" : { "description" : "Date that the business was established, ISO 8601 format ('YYYY-MM-DD')", "type" : "string" }, "id" : { "description" : "Unique identifier for object", "type" : "string" }, "identification_number" : { "description" : "International identification number (max of 30 characters)", "type" : "string" }, "identification_number_type" : { "description" : "Type of international identification number (max of 30 characters)", "type" : "string" }, "incorporation_state" : { "description" : "State (max 2 characters for US, max 3 characters for other countries)", "type" : "string" }, "is_publicly_traded" : { "description" : "Whether the business is a publicly traded entity. Null value means its trading status is unknown.", "type" : "boolean" }, "legal_structure" : { "description" : "How the business is legally structured: one of `ccorp`, `corp`, `estate`, `foreign_entity`, `llc`, `llp`, `lp`, `nonprofit`, `partnership`, `scorp`, `soleprop`, `trust`, or `municipality`", "type" : "string" }, "mailing_address" : { "description" : "Object describing the mailing address of the business", "properties" : { "city" : { "description" : "City (max 18 characters)", "type" : "string" }, "country" : { "description" : "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type" : "string" }, "postal_code" : { "description" : "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type" : "string" }, "state" : { "description" : "State (max 2 characters for US, max 3 characters for other countries)", "type" : "string" }, "street_line_1" : { "description" : "First line of the address (max 35 characters)", "type" : "string" }, "street_line_2" : { "description" : "Optional second line of the address (max 35 characters)", "type" : "string" } }, "type" : "object" }, "naics" : { "description" : "NAICS sector code that describes the industry in which the business operates", "type" : "string" }, "naics_description" : { "description" : "NAICS sector description matching the above NAICS sector code. If 'Other', please use an industry description prefixed with 'Other: '", "type" : "string" }, "name" : { "description" : "Name of the business", "type" : "string" }, "org_id" : { "description" : "ID of the organization with which the object is associated", "type" : "string" }, "parent_businesses" : { "deprecated" : true, "description" : "Array of business IDs pertaining to this business", "items" : { "properties" : { "id" : { "description" : "Parent business application ID", "type" : "string" }, "ownership_percentage" : { "description" : "Ownership percentage of the parent business", "type" : "integer" } }, "type" : "object" }, "type" : "array" }, "person_applications" : { "description" : "Array of objects describing person applications associated with this business", "items" : { "properties" : { "id" : { "description" : "Person application ID", "type" : "string" }, "ownership_percentage" : { "description" : "The person's ownership interest in the business, represented as an integer from 0 to 100", "type" : "integer" }, "roles" : { "description" : "List of applicant's roles, if applicable. Valid roles are `signer`, `control_person`, and `debit_card_holder`", "items" : { "type" : "string" }, "type" : "array" }, "title" : { "description" : "Title of the person within the business (e.g. 'Owner', 'CEO', 'Treasurer')", "type" : "string" } }, "type" : "object" }, "type" : "array" }, "phone_number" : { "description" : "Phone number of the business", "type" : "string" }, "physical_address" : { "description" : "Object describing the physical address of the business", "properties" : { "city" : { "description" : "City (max 18 characters)", "type" : "string" }, "country" : { "description" : "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type" : "string" }, "postal_code" : { "description" : "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type" : "string" }, "state" : { "description" : "State (max 2 characters for US, max 3 characters for other countries)", "type" : "string" }, "street_line_1" : { "description" : "First line of the address (max 35 characters)", "type" : "string" }, "street_line_2" : { "description" : "Optional second line of the address (max 35 characters)", "type" : "string" } }, "type" : "object" }, "tin" : { "description" : "Tax identification number (EIN or other tax ID) for U.S. businesses", "type" : "string" }, "urls" : { "description" : "URLs for the business website(s)", "items" : { "type" : "string" }, "type" : "array" }, "userdata" : { "description" : "Arbitrary data the user can attach to the object", "type" : "object" } } } } }, "description" : "The apply.business-application updated" } }, "summary" : "Update a Business Application", "tags" : [ "Business Application" ] } }, "/apply/deposit" : { "get" : { "parameters" : [ { "description" : "Pagination cursor, value is the object ID.", "in" : "query", "name" : "page_cursor", "schema" : { "type" : "string" } }, { "description" : "Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.", "in" : "query", "name" : "page_size", "schema" : { "default" : 100, "minimum" : 1, "type" : "integer" } }, { "description" : "Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in" : "query", "name" : "from_date", "schema" : { "type" : "string" } }, { "description" : "Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in" : "query", "name" : "to_date", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Success", "value" : { "data" : [ { "ach" : { "account_type" : "checking", "last4" : "2109", "routing_number" : "123456789" }, "amount" : "100.00", "card" : null, "card_token" : null, "created_at" : "2019-03-02T11:53:55Z", "id" : "adpt_01d5wcysg3vz", "name_on_account" : "George Washington", "updated_at" : "2019-03-02T11:53:55Z", "userdata" : null } ] } } }, "schema" : { "properties" : { "data" : { "items" : { "properties" : { "ach" : { "description" : "ACH payment instructions", "properties" : { "account_type" : { "description" : "One of `checking` or `savings`", "type" : "string" }, "last4" : { "description" : "Last 4 digits of the account number", "type" : "string" }, "routing_number" : { "description" : "ABA routing transit number associated with the account", "type" : "string" } }, "type" : "object" }, "amount" : { "description" : "Amount of money to transfer", "pattern" : "^-?[0-9]+[.][0-9][0-9]$", "type" : "string" }, "card" : { "deprecated" : true, "description" : "Debit card payment instructions", "properties" : { "last4" : { "description" : "Last 4 digits of the card number", "type" : "string" } }, "type" : "object" }, "card_token" : { "description" : "Tokenized debit card payment instructions", "properties" : { "description" : { "description" : "Description to use when posting the transaction to the virtual ledger", "type" : "string" }, "first_name" : { "description" : "First name of the card holder", "type" : "string" }, "last_name" : { "description" : "Last name of the card holder", "type" : "string" }, "token" : { "description" : "Token representing the card", "type" : "string" } }, "type" : "object" }, "id" : { "description" : "Unique identifier for object", "type" : "string" }, "name_on_account" : { "description" : "Name of the owner of the account providing the deposit", "type" : "string" }, "userdata" : { "description" : "Arbitrary data the user can attach to the object", "type" : "object" } }, "type" : "object" }, "type" : "array" } } } } }, "description" : "A dictionary with a `data` property that contains a list of up to `page_size` deposit elements, starting after the deposit described by `page_cursor`. If no more deposits are available, the resulting list will be empty." } }, "summary" : "List Deposits", "tags" : [ "Deposit" ] }, "post" : { "requestBody" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Success", "value" : { "ach" : { "account_number" : "98765432109", "account_type" : "checking", "routing_number" : "123456789" }, "amount" : "100.00", "name_on_account" : "George Washington" } } }, "schema" : { "properties" : { "ach" : { "description" : "ACH payment instructions", "properties" : { "account_type" : { "description" : "One of `checking` or `savings`", "type" : "string" }, "routing_number" : { "description" : "ABA routing transit number associated with the account", "type" : "string" } }, "type" : "object" }, "amount" : { "description" : "Amount of money to transfer", "pattern" : "^-?[0-9]+[.][0-9][0-9]$", "type" : "string" }, "card" : { "deprecated" : true, "description" : "Debit card payment instructions", "properties" : { }, "type" : "object" }, "card_token" : { "description" : "Tokenized debit card payment instructions", "properties" : { "description" : { "description" : "Description to use when posting the transaction to the virtual ledger", "type" : "string" }, "first_name" : { "description" : "First name of the card holder", "type" : "string" }, "last_name" : { "description" : "Last name of the card holder", "type" : "string" }, "token" : { "description" : "Token representing the card", "type" : "string" } }, "type" : "object" }, "name_on_account" : { "description" : "Name of the owner of the account providing the deposit", "type" : "string" }, "userdata" : { "description" : "Arbitrary data the user can attach to the object", "type" : "object" } }, "required" : [ "amount", "name_on_account", "id" ] } } }, "description" : "The apply.deposit to create", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Success", "value" : { "ach" : { "account_type" : "checking", "last4" : "2109", "routing_number" : "123456789" }, "amount" : "100.00", "card" : null, "card_token" : null, "created_at" : "2019-03-02T11:53:55Z", "id" : "adpt_01d5wcysg3vz", "name_on_account" : "George Washington", "updated_at" : "2019-03-02T11:53:55Z", "userdata" : null } } }, "schema" : { "properties" : { "ach" : { "description" : "ACH payment instructions", "properties" : { "account_type" : { "description" : "One of `checking` or `savings`", "type" : "string" }, "last4" : { "description" : "Last 4 digits of the account number", "type" : "string" }, "routing_number" : { "description" : "ABA routing transit number associated with the account", "type" : "string" } }, "type" : "object" }, "amount" : { "description" : "Amount of money to transfer", "pattern" : "^-?[0-9]+[.][0-9][0-9]$", "type" : "string" }, "card" : { "deprecated" : true, "description" : "Debit card payment instructions", "properties" : { "last4" : { "description" : "Last 4 digits of the card number", "type" : "string" } }, "type" : "object" }, "card_token" : { "description" : "Tokenized debit card payment instructions", "properties" : { "description" : { "description" : "Description to use when posting the transaction to the virtual ledger", "type" : "string" }, "first_name" : { "description" : "First name of the card holder", "type" : "string" }, "last_name" : { "description" : "Last name of the card holder", "type" : "string" }, "token" : { "description" : "Token representing the card", "type" : "string" } }, "type" : "object" }, "id" : { "description" : "Unique identifier for object", "type" : "string" }, "name_on_account" : { "description" : "Name of the owner of the account providing the deposit", "type" : "string" }, "userdata" : { "description" : "Arbitrary data the user can attach to the object", "type" : "object" } } } } }, "description" : "The apply.deposit created" } }, "summary" : "Create a Deposit", "tags" : [ "Deposit" ] } }, "/apply/deposit/{id}" : { "get" : { "parameters" : [ { "description" : "Unique identifier for object", "in" : "path", "name" : "id", "required" : true, "schema" : { "description" : "Unique identifier for object", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Success", "value" : { "ach" : { "account_type" : "checking", "last4" : "2109", "routing_number" : "123456789" }, "amount" : "100.00", "card" : null, "card_token" : null, "created_at" : "2019-03-02T11:53:55Z", "id" : "adpt_01d5wcysg3vz", "name_on_account" : "George Washington", "updated_at" : "2019-03-02T11:53:55Z", "userdata" : null } } }, "schema" : { "properties" : { "ach" : { "description" : "ACH payment instructions", "properties" : { "account_type" : { "description" : "One of `checking` or `savings`", "type" : "string" }, "last4" : { "description" : "Last 4 digits of the account number", "type" : "string" }, "routing_number" : { "description" : "ABA routing transit number associated with the account", "type" : "string" } }, "type" : "object" }, "amount" : { "description" : "Amount of money to transfer", "pattern" : "^-?[0-9]+[.][0-9][0-9]$", "type" : "string" }, "card" : { "deprecated" : true, "description" : "Debit card payment instructions", "properties" : { "last4" : { "description" : "Last 4 digits of the card number", "type" : "string" } }, "type" : "object" }, "card_token" : { "description" : "Tokenized debit card payment instructions", "properties" : { "description" : { "description" : "Description to use when posting the transaction to the virtual ledger", "type" : "string" }, "first_name" : { "description" : "First name of the card holder", "type" : "string" }, "last_name" : { "description" : "Last name of the card holder", "type" : "string" }, "token" : { "description" : "Token representing the card", "type" : "string" } }, "type" : "object" }, "id" : { "description" : "Unique identifier for object", "type" : "string" }, "name_on_account" : { "description" : "Name of the owner of the account providing the deposit", "type" : "string" }, "userdata" : { "description" : "Arbitrary data the user can attach to the object", "type" : "object" } } } } }, "description" : "The apply.deposit" } }, "summary" : "Fetch a Deposit", "tags" : [ "Deposit" ] } }, "/apply/kyc" : { "get" : { "parameters" : [ { "description" : "Type of KYC waterfall. One of: `personal`, `business`. Filterable.", "in" : "query", "name" : "apply_type", "schema" : { "type" : "string" } }, { "description" : "ID of the KYC product used to evaluate the object. Optional — if omitted, the system will use the organization's default KYC product for the given object_type. Returns 404 if no default product is configured for the org. Filterable.", "in" : "query", "name" : "kyc_product_id", "schema" : { "type" : "string" } }, { "description" : "ID of the object (a person application or business application) for the KYC evaluation. Filterable.", "in" : "query", "name" : "object_id", "schema" : { "type" : "string" } }, { "description" : "One of: `person`, `business`. Filterable.", "in" : "query", "name" : "object_type", "schema" : { "type" : "string" } }, { "description" : "Pagination cursor, value is the object ID.", "in" : "query", "name" : "page_cursor", "schema" : { "type" : "string" } }, { "description" : "Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.", "in" : "query", "name" : "page_size", "schema" : { "default" : 100, "minimum" : 1, "type" : "integer" } }, { "description" : "Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in" : "query", "name" : "from_date", "schema" : { "type" : "string" } }, { "description" : "Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in" : "query", "name" : "to_date", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Success", "value" : { "data" : [ { "alloy" : { "status" : "pending" }, "alloy_full" : null, "apply_true" : null, "created_at" : "2019-12-11T20:34:11Z", "id" : "akyc_11f7av5311234", "kyc_product_id" : "akpt_1209bga8she6", "middesk" : null, "middesk_full" : null, "object_id" : "apsn_01d5w6yaa6vt", "object_type" : "person", "provider" : null, "provider_full" : null, "provider_result" : null, "updated_at" : "2019-12-11T20:34:11Z" } ] } } }, "schema" : { "properties" : { "data" : { "items" : { "properties" : { "alloy" : { "description" : "Object containing a summary of the Alloy KYC evaluation (if enabled)", "type" : "object" }, "alloy_full" : { "description" : "Object containing the full response from Alloy (if enabled)", "type" : "object" }, "apply_type" : { "description" : "Type of KYC waterfall. One of: `personal`, `business`. Filterable.", "type" : "string" }, "id" : { "description" : "Unique identifier for object", "type" : "string" }, "kyc_product_id" : { "description" : "ID of the KYC product used to evaluate the object. Optional — if omitted, the system will use the organization's default KYC product for the given object_type. Returns 404 if no default product is configured for the org. Filterable.", "type" : "string" }, "middesk" : { "deprecated" : true, "description" : "Object containing a summary of the Middesk KYC evaluation (if enabled)", "type" : "object" }, "middesk_full" : { "description" : "Object containing the full response from Middesk (if enabled)", "type" : "object" }, "object_id" : { "description" : "ID of the object (a person application or business application) for the KYC evaluation. Filterable.", "type" : "string" }, "object_type" : { "description" : "One of: `person`, `business`. Filterable.", "type" : "string" }, "provider" : { "description" : "Name of the KYC provider", "type" : "string" }, "provider_full" : { "description" : "Object containing the full KYC provider's response (if enabled)", "type" : "object" }, "provider_result" : { "description" : "Object containing a summary of the KYC provider's evaluation (if enabled)", "properties" : { "outcome" : { "description" : "Outcome of the evaluation. One of: `ok`, `error`, `pending`", "type" : "string" } }, "type" : "object" } }, "type" : "object" }, "type" : "array" } } } } }, "description" : "A dictionary with a `data` property that contains a list of up to `page_size` kyc elements, starting after the kyc described by `page_cursor`. If no more kycs are available, the resulting list will be empty." } }, "summary" : "List KYC Evaluations", "tags" : [ "KYC" ] }, "post" : { "requestBody" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Third-Party KYC", "value" : { "kyc_product_id" : "akpt_1209bga8she7", "object_id" : "apsn_01d5w6yaa6vu", "object_type" : "person", "provider" : "", "provider_full" : { }, "provider_result" : { "outcome" : "ok" } } } }, "schema" : { "properties" : { "kyc_product_id" : { "description" : "ID of the KYC product used to evaluate the object. Optional — if omitted, the system will use the organization's default KYC product for the given object_type. Returns 404 if no default product is configured for the org. Filterable.", "type" : "string" }, "object_id" : { "description" : "ID of the object (a person application or business application) for the KYC evaluation. Filterable.", "type" : "string" }, "object_type" : { "description" : "One of: `person`, `business`. Filterable.", "type" : "string" }, "provider" : { "description" : "Name of the KYC provider", "type" : "string" }, "provider_full" : { "description" : "Object containing the full KYC provider's response (if enabled)", "type" : "object" }, "provider_result" : { "description" : "Object containing a summary of the KYC provider's evaluation (if enabled)", "properties" : { "outcome" : { "description" : "Outcome of the evaluation. One of: `ok`, `error`, `pending`", "type" : "string" } }, "type" : "object" } }, "required" : [ "object_id", "object_type", "id" ] } } }, "description" : "The apply.kyc to create", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Success", "value" : { "alloy" : null, "alloy_full" : null, "apply_true" : null, "created_at" : "2019-12-11T20:34:11Z", "id" : "akyc_11f7av5311234", "kyc_product_id" : "akpt_1209bga8she7", "middesk" : null, "middesk_full" : null, "object_id" : "apsn_01d5w6yaa6vu", "object_type" : "person", "provider" : "", "provider_full" : { }, "provider_result" : { "outcome" : "ok" }, "updated_at" : "2019-12-11T20:34:11Z" } } }, "schema" : { "properties" : { "alloy" : { "description" : "Object containing a summary of the Alloy KYC evaluation (if enabled)", "type" : "object" }, "alloy_full" : { "description" : "Object containing the full response from Alloy (if enabled)", "type" : "object" }, "apply_type" : { "description" : "Type of KYC waterfall. One of: `personal`, `business`. Filterable.", "type" : "string" }, "id" : { "description" : "Unique identifier for object", "type" : "string" }, "kyc_product_id" : { "description" : "ID of the KYC product used to evaluate the object. Optional — if omitted, the system will use the organization's default KYC product for the given object_type. Returns 404 if no default product is configured for the org. Filterable.", "type" : "string" }, "middesk" : { "deprecated" : true, "description" : "Object containing a summary of the Middesk KYC evaluation (if enabled)", "type" : "object" }, "middesk_full" : { "description" : "Object containing the full response from Middesk (if enabled)", "type" : "object" }, "object_id" : { "description" : "ID of the object (a person application or business application) for the KYC evaluation. Filterable.", "type" : "string" }, "object_type" : { "description" : "One of: `person`, `business`. Filterable.", "type" : "string" }, "provider" : { "description" : "Name of the KYC provider", "type" : "string" }, "provider_full" : { "description" : "Object containing the full KYC provider's response (if enabled)", "type" : "object" }, "provider_result" : { "description" : "Object containing a summary of the KYC provider's evaluation (if enabled)", "properties" : { "outcome" : { "description" : "Outcome of the evaluation. One of: `ok`, `error`, `pending`", "type" : "string" } }, "type" : "object" } } } } }, "description" : "The apply.kyc created" } }, "summary" : "Create a KYC Evaluation", "tags" : [ "KYC" ] } }, "/apply/kyc/{id}" : { "get" : { "parameters" : [ { "description" : "Unique identifier for object", "in" : "path", "name" : "id", "required" : true, "schema" : { "description" : "Unique identifier for object", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Success", "value" : { "alloy" : { "status" : "pending" }, "alloy_full" : null, "apply_true" : null, "created_at" : "2019-12-11T20:34:11Z", "id" : "akyc_11f7av5311234", "kyc_product_id" : "akpt_1209bga8she6", "middesk" : null, "middesk_full" : null, "object_id" : "apsn_01d5w6yaa6vt", "object_type" : "person", "provider" : null, "provider_full" : null, "provider_result" : null, "updated_at" : "2019-12-11T20:34:11Z" } } }, "schema" : { "properties" : { "alloy" : { "description" : "Object containing a summary of the Alloy KYC evaluation (if enabled)", "type" : "object" }, "alloy_full" : { "description" : "Object containing the full response from Alloy (if enabled)", "type" : "object" }, "apply_type" : { "description" : "Type of KYC waterfall. One of: `personal`, `business`. Filterable.", "type" : "string" }, "id" : { "description" : "Unique identifier for object", "type" : "string" }, "kyc_product_id" : { "description" : "ID of the KYC product used to evaluate the object. Optional — if omitted, the system will use the organization's default KYC product for the given object_type. Returns 404 if no default product is configured for the org. Filterable.", "type" : "string" }, "middesk" : { "deprecated" : true, "description" : "Object containing a summary of the Middesk KYC evaluation (if enabled)", "type" : "object" }, "middesk_full" : { "description" : "Object containing the full response from Middesk (if enabled)", "type" : "object" }, "object_id" : { "description" : "ID of the object (a person application or business application) for the KYC evaluation. Filterable.", "type" : "string" }, "object_type" : { "description" : "One of: `person`, `business`. Filterable.", "type" : "string" }, "provider" : { "description" : "Name of the KYC provider", "type" : "string" }, "provider_full" : { "description" : "Object containing the full KYC provider's response (if enabled)", "type" : "object" }, "provider_result" : { "description" : "Object containing a summary of the KYC provider's evaluation (if enabled)", "properties" : { "outcome" : { "description" : "Outcome of the evaluation. One of: `ok`, `error`, `pending`", "type" : "string" } }, "type" : "object" } } } } }, "description" : "The apply.kyc" } }, "summary" : "Fetch a KYC Evaluation", "tags" : [ "KYC" ] } }, "/apply/kyc_product" : { "get" : { "parameters" : [ { "description" : "Name of the KYC product. Filterable.", "in" : "query", "name" : "name", "schema" : { "type" : "string" } }, { "description" : "The type of application upon which the KYC product can be run. One of: `person`, `business`. Filterable.", "in" : "query", "name" : "object_type", "schema" : { "type" : "string" } }, { "description" : "Pagination cursor, value is the object ID.", "in" : "query", "name" : "page_cursor", "schema" : { "type" : "string" } }, { "description" : "Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.", "in" : "query", "name" : "page_size", "schema" : { "default" : 100, "minimum" : 1, "type" : "integer" } }, { "description" : "Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in" : "query", "name" : "from_date", "schema" : { "type" : "string" } }, { "description" : "Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in" : "query", "name" : "to_date", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Success", "value" : { "data" : [ { "created_at" : "2019-12-11T20:34:11Z", "id" : "akpt_1209bga8she6", "name" : "product_0", "object_type" : "person", "updated_at" : "2019-12-11T20:34:11Z" } ] } } }, "schema" : { "properties" : { "data" : { "items" : { "properties" : { "id" : { "description" : "Unique identifier for object", "type" : "string" }, "is_default" : { "description" : "Whether this KYC product should run by default if none is specified", "type" : "boolean" }, "name" : { "description" : "Name of the KYC product. Filterable.", "type" : "string" }, "object_type" : { "description" : "The type of application upon which the KYC product can be run. One of: `person`, `business`. Filterable.", "type" : "string" }, "org_id" : { "description" : "ID of the organization that owns the KYC product", "type" : "string" } }, "type" : "object" }, "type" : "array" } } } } }, "description" : "A dictionary with a `data` property that contains a list of up to `page_size` kyc-product elements, starting after the kyc-product described by `page_cursor`. If no more kyc-products are available, the resulting list will be empty." } }, "summary" : "List KYC Products", "tags" : [ "KYC Product" ] } }, "/apply/kyc_product/{id}" : { "get" : { "parameters" : [ { "description" : "Unique identifier for object", "in" : "path", "name" : "id", "required" : true, "schema" : { "description" : "Unique identifier for object", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Success", "value" : { "created_at" : "2019-12-11T20:34:11Z", "id" : "akpt_1209bga8she6", "name" : "product_0", "object_type" : "person", "updated_at" : "2019-12-11T20:34:11Z" } } }, "schema" : { "properties" : { "id" : { "description" : "Unique identifier for object", "type" : "string" }, "is_default" : { "description" : "Whether this KYC product should run by default if none is specified", "type" : "boolean" }, "name" : { "description" : "Name of the KYC product. Filterable.", "type" : "string" }, "object_type" : { "description" : "The type of application upon which the KYC product can be run. One of: `person`, `business`. Filterable.", "type" : "string" }, "org_id" : { "description" : "ID of the organization that owns the KYC product", "type" : "string" } } } } }, "description" : "The apply.kyc-product" } }, "summary" : "Fetch a KYC Product", "tags" : [ "KYC Product" ] } }, "/apply/person_application" : { "get" : { "parameters" : [ { "description" : "ID of the person object created as a result of a successful account application. Filterable.", "in" : "query", "name" : "person_id", "schema" : { "type" : "string" } }, { "description" : "Pagination cursor, value is the object ID.", "in" : "query", "name" : "page_cursor", "schema" : { "type" : "string" } }, { "description" : "Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.", "in" : "query", "name" : "page_size", "schema" : { "default" : 100, "minimum" : 1, "type" : "integer" } }, { "description" : "Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in" : "query", "name" : "from_date", "schema" : { "type" : "string" } }, { "description" : "Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).", "in" : "query", "name" : "to_date", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Success", "value" : { "data" : [ { "bankdata" : { "ip_address" : "127.0.0.40" }, "citizenship" : "US", "created_at" : "2019-03-02T11:55:14Z", "date_of_birth" : "1732-02-22", "email_address" : "gwash@whitehouse.gov", "first_name" : "George", "id" : "apsn_01d5w7mvmwvy", "identification_number" : null, "identification_number_type" : null, "last_name" : "Washington", "middle_name" : null, "occupation" : "General", "person_id" : null, "phone_number" : "2025551111", "physical_address" : { "city" : "Washington", "country" : "US", "postal_code" : "20500", "state" : "DC", "street_line_1" : "1600 Pennsylvania Ave", "street_line_2" : null }, "updated_at" : "2019-03-02T11:55:14Z", "userdata" : null } ] } } }, "schema" : { "properties" : { "data" : { "items" : { "properties" : { "bankdata" : { "description" : "Optional arbitrary data the bank can attach to the object", "type" : "object" }, "citizenship" : { "description" : "Two letter ISO country code indicating where this person has citizenship", "type" : "string" }, "date_of_birth" : { "description" : "Date of birth of the person, ISO 8601 format ('YYYY-MM-DD')", "type" : "string" }, "document_ids" : { "description" : "Array of Document IDs pertaining to this person", "items" : { "type" : "string" }, "type" : "array" }, "email_address" : { "description" : "Email address of the person", "type" : "string" }, "first_name" : { "description" : "First (given) name of the person (max of 36 ASCII characters)", "type" : "string" }, "gov_id" : { "deprecated" : true, "type" : "string" }, "id" : { "description" : "Unique identifier for object", "type" : "string" }, "identification_number" : { "description" : "International identification number (max of 30 characters)", "type" : "string" }, "identification_number_type" : { "description" : "Type of international identification number (max of 30 characters)", "type" : "string" }, "last_name" : { "description" : "Last name (surname) of the person (max of 40 ASCII characters)", "type" : "string" }, "mailing_address" : { "description" : "Object representing the person's mailing address", "properties" : { "city" : { "description" : "City (max 18 characters)", "type" : "string" }, "country" : { "description" : "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type" : "string" }, "postal_code" : { "description" : "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type" : "string" }, "state" : { "description" : "State (max 2 characters for US, max 3 characters for other countries)", "type" : "string" }, "street_line_1" : { "description" : "First line of the address (max 35 characters)", "type" : "string" }, "street_line_2" : { "description" : "Optional second line of the address (max 35 characters)", "type" : "string" } }, "type" : "object" }, "middle_name" : { "description" : "Middle name or initial of the person, if they have one", "type" : "string" }, "occupation" : { "description" : "Occupation of the person", "type" : "string" }, "person_id" : { "description" : "ID of the person object created as a result of a successful account application. Filterable.", "type" : "string" }, "phone_number" : { "description" : "Phone number of the person", "type" : "string" }, "physical_address" : { "description" : "Object representing the person's home address. Required for virtual ledger and some core direct integrations", "properties" : { "city" : { "description" : "City (max 18 characters)", "type" : "string" }, "country" : { "description" : "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type" : "string" }, "postal_code" : { "description" : "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type" : "string" }, "state" : { "description" : "State (max 2 characters for US, max 3 characters for other countries)", "type" : "string" }, "street_line_1" : { "description" : "First line of the address (max 35 characters)", "type" : "string" }, "street_line_2" : { "description" : "Optional second line of the address (max 35 characters)", "type" : "string" } }, "type" : "object" }, "secondary_email_address" : { "description" : "Optional secondary email address of the person", "type" : "string" }, "userdata" : { "description" : "Optional arbitrary data the user can attach to the object", "type" : "object" } }, "type" : "object" }, "type" : "array" } } } } }, "description" : "A dictionary with a `data` property that contains a list of up to `page_size` person-application elements, starting after the person-application described by `page_cursor`. If no more person-applications are available, the resulting list will be empty." } }, "summary" : "List Person Applications", "tags" : [ "Person Application" ] }, "post" : { "requestBody" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Success", "value" : { "bankdata" : { "ip_address" : "127.0.0.40" }, "citizenship" : "US", "date_of_birth" : "1732-02-22", "email_address" : "gwash@whitehouse.gov", "first_name" : "George", "last_name" : "Washington", "occupation" : "General", "phone_number" : "2025551111", "physical_address" : { "city" : "Washington", "postal_code" : "20500", "state" : "DC", "street_line_1" : "1600 Pennsylvania Ave" }, "tin" : "111222444" } } }, "schema" : { "properties" : { "bankdata" : { "description" : "Optional arbitrary data the bank can attach to the object", "type" : "object" }, "citizenship" : { "description" : "Two letter ISO country code indicating where this person has citizenship", "type" : "string" }, "date_of_birth" : { "description" : "Date of birth of the person, ISO 8601 format ('YYYY-MM-DD')", "type" : "string" }, "document_ids" : { "description" : "Array of Document IDs pertaining to this person", "items" : { "type" : "string" }, "type" : "array" }, "email_address" : { "description" : "Email address of the person", "type" : "string" }, "first_name" : { "description" : "First (given) name of the person (max of 36 ASCII characters)", "type" : "string" }, "gov_id" : { "deprecated" : true, "type" : "string" }, "identification_number" : { "description" : "International identification number (max of 30 characters)", "type" : "string" }, "identification_number_type" : { "description" : "Type of international identification number (max of 30 characters)", "type" : "string" }, "last_name" : { "description" : "Last name (surname) of the person (max of 40 ASCII characters)", "type" : "string" }, "mailing_address" : { "description" : "Object representing the person's mailing address", "properties" : { "city" : { "description" : "City (max 18 characters)", "type" : "string" }, "country" : { "description" : "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type" : "string" }, "postal_code" : { "description" : "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type" : "string" }, "state" : { "description" : "State (max 2 characters for US, max 3 characters for other countries)", "type" : "string" }, "street_line_1" : { "description" : "First line of the address (max 35 characters)", "type" : "string" }, "street_line_2" : { "description" : "Optional second line of the address (max 35 characters)", "type" : "string" } }, "type" : "object" }, "middle_name" : { "description" : "Middle name or initial of the person, if they have one", "type" : "string" }, "occupation" : { "description" : "Occupation of the person", "type" : "string" }, "phone_number" : { "description" : "Phone number of the person", "type" : "string" }, "physical_address" : { "description" : "Object representing the person's home address. Required for virtual ledger and some core direct integrations", "properties" : { "city" : { "description" : "City (max 18 characters)", "type" : "string" }, "country" : { "description" : "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type" : "string" }, "postal_code" : { "description" : "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type" : "string" }, "state" : { "description" : "State (max 2 characters for US, max 3 characters for other countries)", "type" : "string" }, "street_line_1" : { "description" : "First line of the address (max 35 characters)", "type" : "string" }, "street_line_2" : { "description" : "Optional second line of the address (max 35 characters)", "type" : "string" } }, "type" : "object" }, "secondary_email_address" : { "description" : "Optional secondary email address of the person", "type" : "string" }, "tin" : { "description" : "U.S. Social Security or IRS tax ID number of the person", "type" : "string" }, "userdata" : { "description" : "Optional arbitrary data the user can attach to the object", "type" : "object" } }, "required" : [ "first_name", "id", "last_name", "email_address" ] } } }, "description" : "The apply.person-application to create", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Success", "value" : { "bankdata" : { "ip_address" : "127.0.0.40" }, "citizenship" : "US", "created_at" : "2019-03-02T11:55:14Z", "date_of_birth" : "1732-02-22", "email_address" : "gwash@whitehouse.gov", "first_name" : "George", "id" : "apsn_01d5w7mvmwvy", "identification_number" : null, "identification_number_type" : null, "last_name" : "Washington", "middle_name" : null, "occupation" : "General", "person_id" : null, "phone_number" : "2025551111", "physical_address" : { "city" : "Washington", "country" : "US", "postal_code" : "20500", "state" : "DC", "street_line_1" : "1600 Pennsylvania Ave", "street_line_2" : null }, "updated_at" : "2019-03-02T11:55:14Z", "userdata" : null } } }, "schema" : { "properties" : { "bankdata" : { "description" : "Optional arbitrary data the bank can attach to the object", "type" : "object" }, "citizenship" : { "description" : "Two letter ISO country code indicating where this person has citizenship", "type" : "string" }, "date_of_birth" : { "description" : "Date of birth of the person, ISO 8601 format ('YYYY-MM-DD')", "type" : "string" }, "document_ids" : { "description" : "Array of Document IDs pertaining to this person", "items" : { "type" : "string" }, "type" : "array" }, "email_address" : { "description" : "Email address of the person", "type" : "string" }, "first_name" : { "description" : "First (given) name of the person (max of 36 ASCII characters)", "type" : "string" }, "gov_id" : { "deprecated" : true, "type" : "string" }, "id" : { "description" : "Unique identifier for object", "type" : "string" }, "identification_number" : { "description" : "International identification number (max of 30 characters)", "type" : "string" }, "identification_number_type" : { "description" : "Type of international identification number (max of 30 characters)", "type" : "string" }, "last_name" : { "description" : "Last name (surname) of the person (max of 40 ASCII characters)", "type" : "string" }, "mailing_address" : { "description" : "Object representing the person's mailing address", "properties" : { "city" : { "description" : "City (max 18 characters)", "type" : "string" }, "country" : { "description" : "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type" : "string" }, "postal_code" : { "description" : "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type" : "string" }, "state" : { "description" : "State (max 2 characters for US, max 3 characters for other countries)", "type" : "string" }, "street_line_1" : { "description" : "First line of the address (max 35 characters)", "type" : "string" }, "street_line_2" : { "description" : "Optional second line of the address (max 35 characters)", "type" : "string" } }, "type" : "object" }, "middle_name" : { "description" : "Middle name or initial of the person, if they have one", "type" : "string" }, "occupation" : { "description" : "Occupation of the person", "type" : "string" }, "person_id" : { "description" : "ID of the person object created as a result of a successful account application. Filterable.", "type" : "string" }, "phone_number" : { "description" : "Phone number of the person", "type" : "string" }, "physical_address" : { "description" : "Object representing the person's home address. Required for virtual ledger and some core direct integrations", "properties" : { "city" : { "description" : "City (max 18 characters)", "type" : "string" }, "country" : { "description" : "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type" : "string" }, "postal_code" : { "description" : "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type" : "string" }, "state" : { "description" : "State (max 2 characters for US, max 3 characters for other countries)", "type" : "string" }, "street_line_1" : { "description" : "First line of the address (max 35 characters)", "type" : "string" }, "street_line_2" : { "description" : "Optional second line of the address (max 35 characters)", "type" : "string" } }, "type" : "object" }, "secondary_email_address" : { "description" : "Optional secondary email address of the person", "type" : "string" }, "tin" : { "description" : "U.S. Social Security or IRS tax ID number of the person", "type" : "string" }, "userdata" : { "description" : "Optional arbitrary data the user can attach to the object", "type" : "object" } } } } }, "description" : "The apply.person-application created" } }, "summary" : "Create a Person Application", "tags" : [ "Person Application" ] } }, "/apply/person_application/{id}" : { "get" : { "parameters" : [ { "description" : "Unique identifier for object", "in" : "path", "name" : "id", "required" : true, "schema" : { "description" : "Unique identifier for object", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "examples" : { "example" : { "summary" : "Success", "value" : { "bankdata" : { "ip_address" : "127.0.0.40" }, "citizenship" : "US", "created_at" : "2019-03-02T11:55:14Z", "date_of_birth" : "1732-02-22", "email_address" : "gwash@whitehouse.gov", "first_name" : "George", "id" : "apsn_01d5w7mvmwvy", "identification_number" : null, "identification_number_type" : null, "last_name" : "Washington", "middle_name" : null, "occupation" : "General", "person_id" : null, "phone_number" : "2025551111", "physical_address" : { "city" : "Washington", "country" : "US", "postal_code" : "20500", "state" : "DC", "street_line_1" : "1600 Pennsylvania Ave", "street_line_2" : null }, "updated_at" : "2019-03-02T11:55:14Z", "userdata" : null } } }, "schema" : { "properties" : { "bankdata" : { "description" : "Optional arbitrary data the bank can attach to the object", "type" : "object" }, "citizenship" : { "description" : "Two letter ISO country code indicating where this person has citizenship", "type" : "string" }, "date_of_birth" : { "description" : "Date of birth of the person, ISO 8601 format ('YYYY-MM-DD')", "type" : "string" }, "document_ids" : { "description" : "Array of Document IDs pertaining to this person", "items" : { "type" : "string" }, "type" : "array" }, "email_address" : { "description" : "Email address of the person", "type" : "string" }, "first_name" : { "description" : "First (given) name of the person (max of 36 ASCII characters)", "type" : "string" }, "gov_id" : { "deprecated" : true, "type" : "string" }, "id" : { "description" : "Unique identifier for object", "type" : "string" }, "identification_number" : { "description" : "International identification number (max of 30 characters)", "type" : "string" }, "identification_number_type" : { "description" : "Type of international identification number (max of 30 characters)", "type" : "string" }, "last_name" : { "description" : "Last name (surname) of the person (max of 40 ASCII characters)", "type" : "string" }, "mailing_address" : { "description" : "Object representing the person's mailing address", "properties" : { "city" : { "description" : "City (max 18 characters)", "type" : "string" }, "country" : { "description" : "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type" : "string" }, "postal_code" : { "description" : "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type" : "string" }, "state" : { "description" : "State (max 2 characters for US, max 3 characters for other countries)", "type" : "string" }, "street_line_1" : { "description" : "First line of the address (max 35 characters)", "type" : "string" }, "street_line_2" : { "description" : "Optional second line of the address (max 35 characters)", "type" : "string" } }, "type" : "object" }, "middle_name" : { "description" : "Middle name or initial of the person, if they have one", "type" : "string" }, "occupation" : { "description" : "Occupation of the person", "type" : "string" }, "person_id" : { "description" : "ID of the person object created as a result of a successful account application. Filterable.", "type" : "string" }, "phone_number" : { "description" : "Phone number of the person", "type" : "string" }, "physical_address" : { "description" : "Object representing the person's home address. Required for virtual ledger and some core direct integrations", "properties" : { "city" : { "description" : "City (max 18 characters)", "type" : "string" }, "country" : { "description" : "Country (ISO 3166-1 alpha-2). Defaults to `US`", "type" : "string" }, "postal_code" : { "description" : "Postal code (5-digit or 5+4 Zip Code for U.S. addresses)", "type" : "string" }, "state" : { "description" : "State (max 2 characters for US, max 3 characters for other countries)", "type" : "string" }, "street_line_1" : { "description" : "First line of the address (max 35 characters)", "type" : "string" }, "street_line_2" : { "description" : "Optional second line of the address (max 35 characters)", "type" : "string" } }, "type" : "object" }, "secondary_email_address" : { "description" : "Optional secondary email address of the person", "type" : "string" }, "userdata" : { "description" : "Optional arbitrary data the user can attach to the object", "type" : "object" } } } } }, "description" : "The apply.person-application" } }, "summary" : "Fetch a Person Application", "tags" : [ "Person Application" ] } } }, "security" : [ { "basicAuth" : [ ] }, { "apiKey" : [ ] } ], "servers" : [ { "description" : "Production", "url" : "https://api.treasuryprime.com" }, { "description" : "Sandbox", "url" : "https://api.sandbox.treasuryprime.com" } ] }