{"openapi":"3.1.0","info":{"title":"Kompliant Web API","version":"v1","contact":{"url":"https://www.kompliant.com/"},"license":{"name":"Proprietary - For Authorized Use Only","url":"https://www.kompliant.com/terms-conditions"}},"paths":{"/v2/application":{"post":{"summary":"Create Application V2","operationId":"CreateApplicationV2","description":"Create a new application, including identifying information about the applying business and its owners. Required fields vary and are dependent on your specific configuration of the Kompliant services. Contact Kompliant for more information.","tags":["Kompliant APIs"],"security":[{"basic_auth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/index-2"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"business_application_id":{"type":"string","description":"String generated by Kompliant used to identify an application."}}}}}},"400":{"description":"bad request (invalid request body)"},"401":{"description":"Authentication (api key) information is missing or invalid (unauthorized)"},"404":{"description":"bad request (no application_id)"}}}},"/v3/application/{application_id}":{"get":{"summary":"Application Details API v3","operationId":"GetApplicationDetailsv3","description":"Use this API to fetch application details by ID.<br>NOTE - this API is not yet functional. Please use Application Details v2.","tags":["Kompliant APIs"],"security":[{"basic_auth":[]}],"parameters":[{"$ref":"#/components/parameters/application_id"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/application_v3"}}}},"401":{"description":"Authentication (api key) information is missing or invalid (unauthorized)"},"404":{"description":"bad request (no application_id)"}}}},"/v1/application/{application_id}/documents/{document_id}":{"get":{"summary":"Retrieve Application Document by Id","operationId":"GetDocumentById","description":"Retrieve supporting documents by ID. Document IDs associated with a given application are provided in the Application Details v2 API.","tags":["Kompliant APIs"],"security":[{"basic_auth":[]}],"parameters":[{"$ref":"#/components/parameters/application_id"},{"$ref":"#/components/parameters/document_id"}],"responses":{"200":{"description":"Success","headers":{"Content-Type":{"description":"Appropirate content type for file being streamed. Kompliant supports a number of different \nfile types. The content type will conform to values maintained by [IANA.](https://www.iana.org/assignments/media-types/media-types.xhtml)\n","example":"application/pdf","schema":{"type":"string"}},"Content-Description":{"schema":{"type":"string"},"description":"File Transfer","example":"File Transfer"},"Content-Disposition":{"example":"attachment; filename=\"statement.pdf\"","description":"filename will be set to name of the file","schema":{"type":"string"}}},"content":{"application/pdf":{"schema":{"type":"string","format":"binary"}},"image/jpeg":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Authentication (api key) is invalid (unauthorized)"},"404":{"description":"Document not found - associated to a different application but same partner"}}}},"/v1/application/{application_id}/msa":{"get":{"summary":"Retrieve Legal Agreement","operationId":"GetMSA","description":"Retrieve legal agreement document by `application_id`. Document is the legally binding document version entered into by the applicant at time of application submission, and includes the full legal agreement text along with acceptance meta data on a cover sheet.","tags":["Kompliant APIs"],"security":[{"basic_auth":[]}],"parameters":[{"$ref":"#/components/parameters/application_id"}],"responses":{"200":{"description":"Success","headers":{"Content-Type":{"description":"Appropirate content type for file being streamed.\n","example":"application/pdf","schema":{"type":"string"}},"Content-Description":{"schema":{"type":"string"},"description":"File Transfer","example":"File Transfer"},"Content-Disposition":{"example":"attachment; filename=\"msa.pdf\"","description":"filename will be set to name of the file","schema":{"type":"string"}}},"content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Authentication (api key) is invalid (unauthorized)"},"404":{"description":"Document not found - most likely because the MSA is not signed yet"}}}},"/v1/application/{application_id}/gpn":{"get":{"summary":"GPN partner creds - Propay, Heartland","operationId":"GetGpnCreds","description":"Use only if partner configuration includes service activation to Global Payments. Returns Propay account information and Heartland credentials for the applicant.","tags":["Kompliant APIs"],"security":[{"basic_auth":[]}],"parameters":[{"$ref":"#/components/parameters/application_id"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gpn"}}}},"401":{"description":"Authentication (api key) information is missing or invalid (unauthorized)"},"404":{"description":"bad request (no application_id, no Propay/Heartland creds records)"}}}},"/v1/application/{application_id}/decisions":{"get":{"summary":"Application Decision Summary API","operationId":"GetApplicationDecisionSummary","description":"Returns decision information for the application as well as each verification service performed on the business and person entities.","tags":["Kompliant APIs"],"security":[{"basic_auth":[]}],"parameters":[{"$ref":"#/components/parameters/application_id"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/decisions_summary"}}}},"401":{"description":"Authentication (api key) information is missing or invalid (unauthorized)"},"404":{"description":"bad request (no application_id)"}}}},"/v1/application/{application_id}/decisions/documents":{"get":{"summary":"Application Decision Defense Document List","operationId":"GetApplicationDecisionDocumentList","description":"Returns an array of previously generated decision defense documents. To generate a decision defense document, use the Generate Defense Decision Document API.","tags":["Kompliant APIs"],"security":[{"basic_auth":[]}],"parameters":[{"$ref":"#/components/parameters/application_id"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/decision_document_list"}}}},"401":{"description":"Authentication (api key) information is missing or invalid (unauthorized)"},"404":{"description":"bad request (no application_id)"}}}},"/v1/application/{application_id}/decisions/documents/generate":{"post":{"summary":"Generate Defense Decision Document","operationId":"GenerateDecisionDocument","description":"Initiate the generation of a decision defense document for a given application. `application_decision_record_id` is available in the Application Decision Summary API response. Current support is limited to “complete” `decision_document_type` which will generate a document that includes a full record of the application self-reported data, all verification results and application decision summary.","tags":["Kompliant APIs"],"security":[{"basic_auth":[]}],"parameters":[{"$ref":"#/components/parameters/application_id"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generate_decision_document"}}}},"responses":{"204":{"description":"Success"},"401":{"description":"Authentication (api key) information is missing or invalid (unauthorized)"},"404":{"description":"bad request (no application_id)"}}}},"/v1/application/{application_id}/decisions/documents/{document_id}":{"get":{"summary":"Retrieve Decision Defense Document by Document Id","operationId":"GetDecisionSupportDocument","description":"Retrieve a decision defense document that has been previously generated. To generate a decision defense document, use the Generate Defense Decision Document API.","tags":["Kompliant APIs"],"security":[{"basic_auth":[]}],"parameters":[{"$ref":"#/components/parameters/application_id"},{"$ref":"#/components/parameters/document_id"}],"responses":{"200":{"description":"Success","headers":{"Content-Type":{"description":"Appropirate content type for file being streamed. Kompliant supports a number of different \nfile types. The content type will conform to values maintained by [IANA.](https://www.iana.org/assignments/media-types/media-types.xhtml)\n","example":"application/pdf","schema":{"type":"string"}},"Content-Description":{"schema":{"type":"string"},"description":"File Transfer","example":"File Transfer"},"Content-Disposition":{"example":"attachment; filename=\"statement.pdf\"","description":"filename will be set to name of the file","schema":{"type":"string"}}},"content":{"application/pdf":{"schema":{"type":"string","format":"binary"}},"image/jpeg":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Authentication (api key) is invalid (unauthorized)"},"404":{"description":"Document not found - associated to a different application but same partner"}}}},"/v1/application/{application_id}/locations":{"get":{"summary":"Locations by Application ID v1","operationId":"GetLocationsByApplicationIdv3","description":"Use this API to fetch list of locations by Application ID.","tags":["Kompliant APIs"],"security":[{"basic_auth":[]}],"parameters":[{"$ref":"#/components/parameters/application_id"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/locations_v1"}}}},"401":{"description":"Authentication (api key) information is missing or invalid (unauthorized)"},"404":{"description":"bad request (no application_id)"}}}},"/v1/application/{application_id}/pricing":{"get":{"summary":"Pricing by Application ID v1","operationId":"GetPricingByApplicationIdV1","description":"Use this API to fetch pricing details by Application ID.<br>NOTE - this API is not yet functional. Please use Application Details v2.","tags":["Kompliant APIs"],"security":[{"basic_auth":[]}],"parameters":[{"$ref":"#/components/parameters/application_id"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/application_pricing_v3"}}}},"401":{"description":"Authentication (api key) information is missing or invalid (unauthorized)"},"404":{"description":"bad request (no application_id)"}}}}},"webhooks":{"application-event":{"post":{"operationId":"PostApplicationEvent","summary":"Webhook for Application Events","description":"The application event Webhook is used to notify subscribers of events related to Application Processing, Verification Services and Underwriting Workflow Management.","tags":["Webhook Notifications"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/application_event"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"},"400":{"description":"Bad Request"}},"security":[]}},"application-event-propay":{"post":{"operationId":"PostApplicationEventPropay","summary":"Webhook for Propay Events","description":"Webhook event invoked after application submission to Propay.","tags":["Webhook Notifications"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/application_event_propay"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"},"400":{"description":"Bad Request"}},"security":[]}},"application-event-heartland":{"post":{"operationId":"PostApplicationEventHeartland","summary":"Webhook for Heartland Credentials","description":"Webhook event invoked after receiving Heartland credentials.","tags":["Webhook Notifications"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/application_event_heartland"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"},"400":{"description":"Bad Request"}},"security":[]}}},"servers":[{"url":"https://api.kompliant.com","description":"Kompliant API Production URL"}],"tags":[{"name":"Kompliant APIs","description":"Kompliant APIs provide our customers the ability to access data across the entire compliance lifecycle, from application processing to decision support, ongoing monitoring and decision defense."},{"name":"Webhook Notifications","description":"Webhooks can be used to receive updates about changes to data and workflow statuses. Use the notifications to initiate subsequent workflows based on these events. When an event occurs, Kompliant will submit a POST request to the customer webhook URL with information about the event.<br><br>\nCustomer webhook URLs are provided by the customer and setup by the Kompliant team at the time of initial partner configuration. Separate webhook URLs for sandbox and production environments can be provided.<br><br>\nFor customers managing multiple partner configurations, each configuration requires its own webhook URL. Since you control the complete URL structure, including query parameters, you can differentiate between configurations by including the partner configuration identifier (partner_id) in the URL - for example, `https://yoursite.com/webhooks?partner_id=rockoutpay`. This allows your application to route callbacks appropriately based on both the query parameters and the POST payload.<br><br>\nWebhook notifications are sent from one of the following IP addresses. Partners are encouraged to whitelist all of these IP addresses in their applications.<br><br>\n`3.230.141.132`<br>\n`35.166.77.7`<br>\n`52.27.236.245`<br>\n`54.86.192.161`<br>\n"}],"security":[{"basic_auth":[]}],"components":{"securitySchemes":{"basic_auth":{"type":"http","scheme":"basic","description":"Kompliant utilizes Basic HTTP Authorization (username/password). Each partner configuration requires a unique set of credentials. These credentials are provided through secure channels by our Customer Success team after initial partner setup and configuration is complete."}},"schemas":{"date":{"type":"string","description":"ISO 8601 Date. Format YYYY-MM-DD","example":"1965-02-23"},"country":{"type":"string","description":"ISO 3166 Alpha-3 Country Code","example":"USA"},"address":{"type":"object","properties":{"address":{"type":"string","minLength":1,"maxLength":100,"example":"123 Main St"},"address2":{"type":"string","minLength":1,"maxLength":100,"example":"STE 3"},"city":{"type":"string","minLength":1,"maxLength":30,"example":"Mytown"},"state":{"type":"string","description":"USPS two-character State code. [Postal addressing standards - Appendix B](https://pe.usps.com/text/pub28/28apb.htm)","minLength":2,"maxLength":2,"example":"CA"},"zip":{"type":"string","minLength":5,"maxLength":5,"description":"5-digit ZIP Code.","example":"90078"},"country":{"$ref":"#/components/schemas/country"}},"required":["address","city","state","zip","country"]},"sales_method":{"type":"object","description":"The percentage of card sales in the respective acceptance method. Sum of all fields must equal 100.","properties":{"retail":{"type":"integer","example":50,"description":"Use whole numbers. Range 0-100."},"telephone":{"type":"integer","example":0,"description":"Use whole numbers. Range 0-100."},"online":{"type":"integer","example":40,"description":"Use whole numbers. Range 0-100."},"keyed":{"type":"integer","example":10,"description":"Use whole numbers. Range 0-100."}},"required":["retail","telephone","online","keyed"]},"sales_amount":{"type":"object","description":"Information about current card payment acceptance volume of the applicant.","properties":{"average_monthly_credit_sales":{"type":"integer","minLength":1,"maxLength":9,"example":10000,"description":"Average monthly card sales of the applicant entity. Use whole numbers."},"average_individual_sale":{"type":"integer","example":50,"minLength":1,"maxLength":9,"description":"Average ticket size of the applicant entity. Use whole numbers."},"highest_ticket_sales":{"type":"integer","example":75,"minLength":1,"maxLength":9,"description":"Highest ticket amount of the applicant entity. Use whole numbers."}},"required":["average_monthly_credit_sales","average_individual_sale","highest_ticket_sales"]},"social":{"type":"object","properties":{"facebook":{"type":"string","minLength":1,"maxLength":255,"example":"facebookuser1","description":"Facebook username owned by the applicant."},"twitter":{"type":"string","minLength":1,"maxLength":255,"example":"twitteruser1","description":"X (formerly called Twitter) username owned by the appying business."},"linkedin":{"type":"string","minLength":1,"maxLength":255,"example":"linkedinuser1","description":"LinkedIn username owned by the applicant."},"instagram":{"type":"string","minLength":1,"maxLength":255,"example":"instagramuser1","description":"Instagram username owned by the applicant."},"youtube":{"type":"string","minLength":1,"maxLength":255,"example":"youtubeuser1","description":"YouTube username owned by the applicant."}}},"entity":{"type":"object","description":"Information about the business entity.","properties":{"onboarding_email":{"type":"string","minLength":1,"maxLength":255,"description":"The primary email address used by the applicant entity.","example":"email@example.com"},"legal_name":{"type":"string","minLength":1,"maxLength":255,"description":"The legally registered name of the applicant entity.","example":"Acme Corporation"},"dba":{"type":"string","minLength":1,"maxLength":255,"description":"Doing Business As name (if none, use legal name).","example":"Acme Bird Seed"},"taxid":{"type":"string","minLength":9,"maxLength":9,"description":"Tax identification number, such as Employer Identification Number (EIN) or Social Security Number (SSN). Must be a nine-digit string.","example":"123456789"},"phone_number":{"type":"string","minLength":10,"maxLength":10,"description":"10-digit primary phone number used by the applicant entity.","example":"4153231212"},"mcc":{"type":"integer","minLength":4,"maxLength":4,"description":"4-digit Merchant Category Code (MCC) of the applicant entity.","example":4225},"website":{"type":"string","minLength":1,"maxLength":255,"description":"URL of the website used by the applicant entity.","example":"acmebirdseed.com"},"established_date":{"$ref":"#/components/schemas/date"},"registration_type":{"enum":["sole_proprietorship","partnership_public","partnership_private","non_profit","llc_public","llc_private","government","corporation_public","corporation_private"],"description":"Legal entity type of the applicant entity.","example":"corporation_private"},"address":{"type":"object","properties":{"legal_address":{"$ref":"#/components/schemas/address","description":"Legally registered address of the applicant entity. Do not use PO Box or mailbox addresses."},"mailing_address":{"$ref":"#/components/schemas/address","description":"Mailing address, if different than the legal address."}},"required":["legal_address"]},"product_and_services":{"type":"string","minLength":1,"maxLength":255,"description":"Short description of the type of product and/or services offered by the applicant entity.","example":"Farm supplies and animal foods"},"sales_method":{"$ref":"#/components/schemas/sales_method"},"sales_amount":{"$ref":"#/components/schemas/sales_amount"},"social":{"$ref":"#/components/schemas/social","description":"Social media usernames, or handles, used by the applicant entity."}},"required":["onboarding_email","legal_name","dba","taxid","phone_number","mcc","established_date","registration_type","address","sales_method","sales_amount"]},"bank_account":{"type":"object","properties":{"account_ownership_type":{"type":"string","enum":["business","individual"],"example":"business"},"account_type":{"type":"string","enum":["checking","savings"],"example":"checking"},"routing_number":{"type":"string","example":"121000358","minLength":9,"maxLength":9,"description":"9-digit ABA Routing Number."},"account_number":{"type":"string","example":"12345678","minLength":8,"maxLength":17,"description":"Unique identifier for the bank account."}},"required":["account_ownership_type","account_type","routing_number","account_number"]},"beneficial_owners":{"properties":{"email":{"type":"string","minLength":1,"maxLength":255,"description":"The personal email address used by the owner.","example":"email@example.com"},"first_name":{"type":"string","minLength":1,"maxLength":255,"description":"Full legal first name of the owner.","example":"Wile"},"middle_name":{"type":"string","minLength":1,"maxLength":255,"description":"Full legal middle name of the owner.","example":"Ethelbert"},"last_name":{"type":"string","minLength":1,"maxLength":255,"description":"Full legal last name of the owner.","example":"Coyote"},"date_of_birth":{"$ref":"#/components/schemas/date"},"ssn":{"type":"string","description":"Social Security Number of the owner. Must be a nine-digit string.","minLength":9,"maxLength":9,"example":"321445678"},"is_control_prong":{"type":"boolean","description":"Indicates if this person is the Control Prong of Ultimate Beneficial Ownership.","example":true},"ownership_percentage":{"type":"number","description":"Percentage share of the company owned by this person. Use whole numbers. Range 0-100.","example":65},"title":{"type":"string","minLength":0,"maxLength":255,"description":"The job title or role of this person at the company.","example":"President"},"citizenship":{"type":"string","minLength":3,"maxLength":3,"description":"Country of citizenship. Use ISO 3166-1 alpha-3 codes.","example":"USA"},"phone_number":{"type":"string","minLength":10,"maxLength":10,"description":"10-digit personal phone number of the person.","example":"6504349898"},"address":{"type":"object","$ref":"#/components/schemas/address","description":"Personal home address of the owner."}},"required":["email","first_name","last_name","date_of_birth","ssn","is_control_prong","ownership_percentage","phone_number","address"]},"index":{"type":"object","properties":{"entity":{"type":"object","$ref":"#/components/schemas/entity"},"bank_account":{"type":"object","$ref":"#/components/schemas/bank_account"},"persons":{"type":"array","description":"Information about persons who are beneficial owners of the entity. Include control prong and ownership prong.","items":{"$ref":"#/components/schemas/beneficial_owners"}}},"required":["entity","bank_account","persons"]},"sales_method-2":{"type":"object","description":"The percentage of card sales in the respective acceptance method. Sum of all fields must equal 100.","properties":{"retail":{"type":"integer","example":50,"description":"Use whole numbers. Range 0-100."},"telephone":{"type":"integer","example":0,"description":"Use whole numbers. Range 0-100."},"online":{"type":"integer","example":40,"description":"Use whole numbers. Range 0-100."},"keyed":{"type":"integer","example":10,"description":"Use whole numbers. Range 0-100."}}},"sales_amount-2":{"type":"object","description":"Information about current card payment acceptance volume of the applicant.","properties":{"average_monthly_credit_sales":{"type":"integer","minLength":1,"maxLength":9,"example":10000,"description":"Average monthly card sales of the applicant entity. Use whole numbers."},"average_individual_sale":{"type":"integer","example":50,"minLength":1,"maxLength":9,"description":"Average ticket size of the applicant entity. Use whole numbers."},"highest_ticket_sales":{"type":"integer","example":75,"minLength":1,"maxLength":9,"description":"Highest ticket amount of the applicant entity. Use whole numbers."},"average_yearly_credit_sales":{"type":"integer","minLength":1,"maxLength":9,"example":120000,"description":"Average yearly card sales of the applicant entity. Use whole numbers."},"is_amex_pricing":{"type":"boolean","example":true,"description":"Indicates if the applicant wants to accept American Express payments."}}},"entity-2":{"type":"object","description":"Information about the business entity.","properties":{"onboarding_email":{"type":"string","minLength":1,"maxLength":255,"description":"The primary email address used by the applicant entity.","example":"email@example.com"},"legal_name":{"type":"string","minLength":1,"maxLength":255,"description":"The legally registered name of the applicant entity.","example":"Acme Corporation"},"dba":{"type":"string","minLength":1,"maxLength":255,"description":"Doing Business As name (if none, use legal name).","example":"Acme Bird Seed"},"taxid":{"type":"string","minLength":9,"maxLength":9,"description":"Tax identification number, such as Employer Identification Number (EIN) or Social Security Number (SSN). Must be a nine-digit string.","example":"123456789"},"phone_number":{"type":"string","minLength":10,"maxLength":10,"description":"10-digit primary phone number used by the applicant entity.","example":"4153231212"},"mcc":{"type":"integer","minLength":4,"maxLength":4,"description":"4-digit Merchant Category Code (MCC) of the applicant entity.","example":4225},"website":{"type":"string","minLength":1,"maxLength":255,"description":"URL of the website used by the applicant entity.","example":"acmebirdseed.com"},"established_date":{"$ref":"#/components/schemas/date"},"registration_type":{"enum":["sole_proprietorship","partnership_public","partnership_private","non_profit","llc_public","llc_private","government","corporation_public","corporation_private"],"description":"Legal entity type of the applicant entity.","example":"corporation_private"},"address":{"type":"object","properties":{"legal_address":{"$ref":"#/components/schemas/address","description":"Legally registered address of the applicant entity. Do not use PO Box or mailbox addresses."},"mailing_address":{"$ref":"#/components/schemas/address","description":"Mailing address, if different than the legal address."}}},"product_and_services":{"type":"string","minLength":1,"maxLength":255,"description":"Short description of the type of product and/or services offered by the applicant entity.","example":"Farm supplies and animal foods"},"sales_method":{"$ref":"#/components/schemas/sales_method-2"},"sales_amount":{"$ref":"#/components/schemas/sales_amount-2"},"social":{"$ref":"#/components/schemas/social","description":"Social media usernames, or handles, used by the applicant entity."}},"required":["onboarding_email"]},"beneficial_owners-2":{"properties":{"email":{"type":"string","minLength":1,"maxLength":255,"description":"The personal email address used by the owner.","example":"email@example.com"},"first_name":{"type":"string","minLength":1,"maxLength":255,"description":"Full legal first name of the owner.","example":"Wile"},"middle_name":{"type":"string","minLength":1,"maxLength":255,"description":"Full legal middle name of the owner.","example":"Ethelbert"},"last_name":{"type":"string","minLength":1,"maxLength":255,"description":"Full legal last name of the owner.","example":"Coyote"},"date_of_birth":{"$ref":"#/components/schemas/date"},"ssn":{"type":"string","description":"Social Security Number of the owner. Must be a nine-digit string.","minLength":9,"maxLength":9,"example":"321445678"},"is_control_prong":{"type":"boolean","description":"Indicates if this person is the Control Prong of Ultimate Beneficial Ownership.","example":true},"ownership_percentage":{"type":"number","description":"Percentage share of the company owned by this person. Use whole numbers. Range 0-100.","example":65},"ownership_length":{"type":"string","description":"The date from which this person has owned the company. Format YYYY-MM","example":"1966-02"},"title":{"type":"string","minLength":0,"maxLength":255,"description":"The job title or role of this person at the company.","example":"President"},"citizenship":{"type":"string","minLength":3,"maxLength":3,"description":"Country of citizenship. Use ISO 3166-1 alpha-3 codes.","example":"USA"},"phone_number":{"type":"string","minLength":10,"maxLength":10,"description":"10-digit personal phone number of the person.","example":"6504349898"},"address":{"type":"object","$ref":"#/components/schemas/address","description":"Personal home address of the owner."}}},"bank_account-2":{"type":"object","properties":{"account_ownership_type":{"type":"string","enum":["business","individual"],"example":"business"},"account_type":{"type":"string","enum":["checking","savings"],"example":"checking"},"routing_number":{"type":"string","example":"121000358","minLength":9,"maxLength":9,"description":"9-digit ABA Routing Number."},"account_number":{"type":"string","example":"12345678","minLength":8,"maxLength":17,"description":"Unique identifier for the bank account."},"bank_name":{"type":"string","example":"Bank of America","description":"Name of the bank."},"account_purpose":{"type":"string","enum":["PRIMARY","SETTLEMENT","DISBURSEMENT","FEES"],"example":"PRIMARY","description":"Purpose of the bank account."},"is_primary":{"type":"boolean","example":true,"description":"Indicates if the bank account is primary."}},"required":["account_ownership_type","account_type","routing_number","account_number","account_purpose"]},"index-2":{"type":"object","properties":{"entity":{"type":"object","$ref":"#/components/schemas/entity-2"},"persons":{"type":"array","description":"Information about persons who are beneficial owners of the entity. Include control prong and ownership prong.","items":{"$ref":"#/components/schemas/beneficial_owners-2"}},"bank_accounts":{"type":"array","description":"Information about bank accounts of the entity.","items":{"$ref":"#/components/schemas/bank_account-2"}}},"required":["entity"]},"mcc":{"type":"object","description":"Merchant Category Code","properties":{"code":{"type":"number","example":5013},"base_category":{"type":"string","example":"B2B"},"description":{"type":"string","example":"Misc. business-to-business"}}},"date-2":{"type":"string","description":"ISO 8601 Date. Format YYYY-MM-DD","example":"2010-02-23"},"sales_method-3":{"type":"object","properties":{"retail":{"type":"number","example":15},"telephone":{"type":"number","example":10},"online":{"type":"number","example":40},"keyed":{"type":"number","example":35}}},"sales_amount-3":{"type":"object","properties":{"average_monthly_credit_sales":{"type":"number"},"average_individual_sale":{"type":"number"},"highest_ticket_sales":{"type":"number"}}},"social-2":{"type":"object","properties":{"facebook":{"type":"string","example":"facebook.com","description":"Facebook account owned by the applicant."},"twitter":{"type":"string","example":"game22","description":"Twitter account owned by the appying business."},"linkedin":{"type":"string","example":"linkedin.com/user","description":"LinkedIn account owned by the applicant."},"instagram":{"type":"string","description":"Instagram account owned by the applicant."},"youtube":{"type":"string","example":"youtube.com/user","description":"YouTube account owned by the applicant."}}},"address-2":{"type":"object","properties":{"address":{"type":"string","example":"123 Main St."},"address2":{"type":"string","example":"STE 3"},"city":{"type":"string","example":"Mytown"},"state":{"type":"string","description":"USPS two-character State code. [Postal addressing standards - Appendix B](https://pe.usps.com/text/pub28/28apb.htm)","example":"CA"},"zip":{"type":"string","example":"90078","description":"5-digit ZIP Code."},"country":{"$ref":"#/components/schemas/country"}},"required":["address","city","state","zip","country"]},"business_application_v2":{"type":"object","properties":{"legal_name":{"type":"string","description":"The legal name of the business."},"dba":{"type":"string","description":"Doing Business As name."},"taxid":{"type":"string","description":"Tax Id, such as Federal Employer Identification Number"},"onboarding_email":{"type":"string","example":"david.smith@example.com"},"phone_number":{"type":"string","description":"Business phone number"},"mcc":{"$ref":"#/components/schemas/mcc"},"website":{"type":"string","example":"example.com"},"established_date":{"$ref":"#/components/schemas/date-2"},"registration_type":{"enum":["sole_proprietorship","partnership_public","partnership_private","non_profit","llc_public","llc_private","government","corporation_public","corporation_private"],"description":"Type of business for application."},"product_and_services":{"type":"string"},"transaction_type":{"type":"string","enum":["internet","lodging","moto","restaurant","retail","retail_w_tip"]},"sales_method":{"$ref":"#/components/schemas/sales_method-3"},"sales_amount":{"$ref":"#/components/schemas/sales_amount-3"},"social":{"$ref":"#/components/schemas/social-2","description":"Social media accounts owned by the applying business."},"legal_address":{"$ref":"#/components/schemas/address-2"},"mailing_address":{"$ref":"#/components/schemas/address-2"}}},"iso_datestamp":{"type":"string","format":"date-time","description":"ISO 8601 Timestamp.","example":"2022-08-22T11:43:06-07:00"},"business_owners_document":{"type":"object","properties":{"name":{"type":"string"},"document_id":{"type":"string"},"created_at":{"$ref":"#/components/schemas/iso_datestamp"}}},"beneficial_owners_v2":{"properties":{"first_name":{"type":"string","example":"David"},"last_name":{"type":"string","example":"Smith"},"title":{"type":"string"},"date_of_birth":{"$ref":"#/components/schemas/date-2"},"email":{"type":"string","example":"david.smith@example.com"},"phone_number":{"type":"string"},"address":{"$ref":"#/components/schemas/address-2"},"ownership_percentage":{"type":"number","example":50},"ssn":{"type":"string","description":"Social Security Number"},"is_control_prong":{"type":"boolean"},"citizenship":{"type":"string"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/business_owners_document"}}}},"bank_account_v2":{"type":"object","properties":{"account_type":{"type":"string","enum":["checking","savings"]},"account_ownership_type":{"type":"string","enum":["business","individual"]},"routing_number":{"type":"string"},"account_number":{"type":"string"},"country_code":{"$ref":"#/components/schemas/country"}}},"selected_equipments":{"properties":{"external_item_id":{"type":"string"},"quantity":{"type":"number"},"per_item_price":{"type":"number"},"sale_type":{"type":"string","example":"loan"}}},"equipment_selection":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/selected_equipments"}}}},"application_pricing":{"type":"object","properties":{"pricing_type":{"type":"string","example":"CASH_DISCOUNT"},"application_fee":{"type":"number","example":12},"per_transaction_rate":{"type":"number","example":0.51},"per_transaction_fee":{"type":"number","example":0.31},"monthly_subscription_fee":{"type":"number","example":10},"annual_subscription_fee":{"type":"number","example":0}}},"application_compatability":{"type":"object","properties":{"risk_level":{"type":"string"},"evaluated_at":{"$ref":"#/components/schemas/iso_datestamp"}}},"document":{"type":"object","properties":{"name":{"type":"string"},"document_id":{"type":"string"},"created_at":{"$ref":"#/components/schemas/iso_datestamp"}}},"attribution":{"type":"object","properties":{"referrer_id":{"type":"string","description":"Referrence id supplied in the onboarding url"},"query_parameters":{"type":"string","description":"Query parameters included during application signup"}}},"application_v2":{"type":"object","properties":{"application_id":{"type":"string","description":"Kompliant-generated unique identifier for the application."},"partner_id":{"type":"string","description":"Kompliant-generated unique identifier for the partner."},"entity":{"$ref":"#/components/schemas/business_application_v2"},"persons":{"type":"array","items":{"$ref":"#/components/schemas/beneficial_owners_v2"}},"bank_account":{"$ref":"#/components/schemas/bank_account_v2"},"equipment_selection":{"$ref":"#/components/schemas/equipment_selection"},"pricing":{"$ref":"#/components/schemas/application_pricing"},"compatability":{"$ref":"#/components/schemas/application_compatability"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/document"}},"attributions":{"$ref":"#/components/schemas/attribution"}}},"sales_amount_v3":{"type":"object","properties":{"average_monthly_credit_sales":{"type":"number"},"average_yearly_credit_sales":{"type":"number"},"average_individual_sale":{"type":"number"},"highest_ticket_sales":{"type":"number"},"is_amex_pricing":{"type":"boolean"}}},"business_application_v3":{"type":"object","properties":{"legal_name":{"type":"string","description":"The legal name of the business."},"dba":{"type":"string","description":"Doing Business As name."},"taxid":{"type":"string","description":"Tax Id, such as Federal Employer Identification Number"},"onboarding_email":{"type":"string","example":"david.smith@example.com"},"phone_number":{"type":"string","description":"Business phone number"},"mcc":{"$ref":"#/components/schemas/mcc"},"website":{"type":"string","example":"example.com"},"established_date":{"$ref":"#/components/schemas/date-2"},"registration_type":{"enum":["sole_proprietorship","partnership_public","partnership_private","non_profit","llc_public","llc_private","government","corporation_public","corporation_private"],"description":"Type of business for application."},"product_and_services":{"type":"string"},"transaction_type":{"type":"string","enum":["internet","lodging","moto","restaurant","retail","retail_w_tip"]},"sales_method":{"$ref":"#/components/schemas/sales_method-3"},"sales_amount":{"$ref":"#/components/schemas/sales_amount_v3"},"social":{"$ref":"#/components/schemas/social-2","description":"Social media accounts owned by the applying business."},"legal_address":{"$ref":"#/components/schemas/address-2"},"mailing_address":{"$ref":"#/components/schemas/address-2"}}},"beneficial_owners_v3":{"properties":{"first_name":{"type":"string","example":"David"},"middle_name":{"type":"string","example":"Humberto"},"last_name":{"type":"string","example":"Smith"},"title":{"type":"string"},"date_of_birth":{"$ref":"#/components/schemas/date-2"},"email":{"type":"string","example":"david.smith@example.com"},"phone_number":{"type":"string"},"address":{"$ref":"#/components/schemas/address-2"},"ownership_percentage":{"type":"number","example":50},"ssn":{"type":"string","description":"Social Security Number"},"is_control_prong":{"type":"boolean"},"citizenship":{"type":"string"},"ownership_length":{"type":"string"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/business_owners_document"}}}},"bank_account_v3":{"type":"object","properties":{"account_type":{"type":"string","enum":["checking","savings"]},"account_ownership_type":{"type":"string","enum":["business","individual"]},"routing_number":{"type":"string"},"account_number":{"type":"string"},"country_code":{"$ref":"#/components/schemas/country"},"account_purpose":{"type":"string"}}},"application_v3":{"type":"object","properties":{"application_id":{"type":"string","description":"Kompliant-generated unique identifier for the application."},"partner_id":{"type":"string","description":"Kompliant-generated unique identifier for the partner."},"entity":{"$ref":"#/components/schemas/business_application_v3"},"persons":{"type":"array","items":{"$ref":"#/components/schemas/beneficial_owners_v3"}},"bank_accounts":{"type":"array","items":{"$ref":"#/components/schemas/bank_account_v3"}},"equipment_selection":{"$ref":"#/components/schemas/equipment_selection"},"compatibility":{"$ref":"#/components/schemas/application_compatability"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/document"}},"attributions":{"$ref":"#/components/schemas/attribution"}}},"propay":{"type":"object","properties":{"account_number":{"type":"number","example":718576221},"email":{"type":"string","example":"jiwerib518@galcake.com"},"password":{"type":"string","example":"Xcu!byX2YG"},"tier":{"type":"string","example":"tier1"}}},"heartland":{"type":"object","properties":{"credentials":{"type":"object","properties":{"device_id":{"type":"number","example":1234567},"site_id":{"type":"number","example":12345},"public_api_key":{"type":"string","example":"pkapi_prod_notREALkeyDATA"},"secret_api_key":{"type":"string","example":"skapi_prod_notREALkeyDATA"},"website":{"type":"string","example":718576221},"merchant_id":{"type":"string","example":123456789123456}}}}},"gpn":{"type":"object","properties":{"propay":{"$ref":"#/components/schemas/propay"},"heartland":{"$ref":"#/components/schemas/heartland"}}},"decision_status":{"type":"string","example":"APPROVED","enum":["IN_PROGRESS","PENDING_REVIEW","IN_REVIEW","PAUSED","APPROVED","DECLINED","WITHDRAWN","NO_DECISION"],"description":"Indicates the status of the application within the decisioning workflow."},"verification_status":{"type":"string","example":"PASS","enum":["PASS","FAIL","NEEDS_REVIEW"],"description":"If null, undecisioned."},"verification_record_id":{"type":"string","description":"ID of verification details record that supports decision.\n"},"decision_content":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/verification_status"},"decisioned_at":{"$ref":"#/components/schemas/iso_datestamp"},"comment":{"type":"string","description":"Underwriter comment about decision. Null if undecisioned."},"decision_record_id":{"$ref":"#/components/schemas/verification_record_id"}}},"decisions_verifications":{"type":"object","properties":{"entity":{"type":"object","properties":{"entity_verification":{"$ref":"#/components/schemas/decision_content"},"sanctions_screen":{"$ref":"#/components/schemas/decision_content"},"risk_assessment":{"type":"object","properties":{"risk_flags":{"$ref":"#/components/schemas/decision_content"}}},"match":{"$ref":"#/components/schemas/decision_content"},"financial_information":{"type":"object","properties":{"bank_account":{"$ref":"#/components/schemas/decision_content"}}},"enhanced_due_diligence":{"type":"object","properties":{"site_analysis":{"$ref":"#/components/schemas/decision_content"}}}}},"persons":{"type":"object","properties":{"entities_verification":{"$ref":"#/components/schemas/decision_content"},"sanctions_screen":{"$ref":"#/components/schemas/decision_content"},"risk_assessment":{"type":"object","properties":{"risk_flags":{"$ref":"#/components/schemas/decision_content"}}},"fraud_analysis":{"$ref":"#/components/schemas/decision_content"}}}}},"decisions_summary":{"type":"object","properties":{"application_id":{"type":"string","description":"Id of the application"},"application_decision_record_id":{"type":"string","description":"Id of the application decision record"},"status":{"$ref":"#/components/schemas/decision_status"},"decisioned_by":{"type":"string"},"decisioned_at":{"$ref":"#/components/schemas/iso_datestamp"},"verifications_decision":{"$ref":"#/components/schemas/decisions_verifications"}}},"defense_document_list":{"properties":{"document_id":{"type":"string","example":"6c8e3bbd-a4e5-4995-80f4-f1b1fefb3fd0","description":"Id of the defense document"},"file_name":{"type":"string","example":"Report_TestBiz_Complete_09282023.pdf","description":"Name of the defense document"},"decision_document_type":{"type":"string","enum":["complete"],"example":"complete","description":"Defense document type"},"status":{"type":"string","enum":["in_progress","completed"],"example":"completed","description":"Defense document generation status"},"created_by":{"type":"string","example":"david.smith@example.com","description":"Defense document generator"},"created_at":{"$ref":"#/components/schemas/iso_datestamp"},"updated_at":{"$ref":"#/components/schemas/iso_datestamp"}}},"decision_document_list":{"type":"object","properties":{"documents":{"type":"array","items":{"$ref":"#/components/schemas/defense_document_list"}}}},"generate_decision_document":{"type":"object","properties":{"application_decision_record_id":{"type":"string","description":"Kompliant-generated unique identifier for the application decision.","example":"046c5273-cc55-4047-b9ca-26263a9763ac"},"decision_document_type":{"type":"string","description":"Type of decision document to generate.","enum":["complete"],"example":"complete"}},"required":["application_decision_record_id","decision_document_type"]},"location_bank_account_v1":{"type":"object","properties":{"account_type":{"type":"string","enum":["checking","savings"]},"account_ownership_type":{"type":"string","enum":["business","individual"]},"routing_number":{"type":"string"},"account_number":{"type":"string"},"country_code":{"$ref":"#/components/schemas/country"},"location_bank_account_purpose":{"type":"string"}}},"location_v1":{"type":"object","properties":{"location_id":{"type":"string"},"location_type":{"type":"string","enum":["property"]},"location_name":{"type":"string"},"owner_name":{"type":"string"},"address":{"$ref":"#/components/schemas/address-2"},"bank_accounts":{"type":"array","items":{"$ref":"#/components/schemas/location_bank_account_v1"}},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}},"locations_v1":{"type":"object","properties":{"locations":{"type":"array","items":{"$ref":"#/components/schemas/location_v1"}}}},"application_pricing_v3":{"type":"object","properties":{"pricing_type":{"type":"string","enum":["cash_discount","interchange"]},"pricing_items":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["flat","percentage","boolean"]},"name":{"type":"string","enum":["ach","ach_disbursement_fee","ach_per_transaction_fee","ach_return_fee","amex","amex_per_transaction_fee","amex_rate","annual_subscription_fee","application_fee","blended_rate","chargeback_fee","credit_card_per_transaction_fee","credit_card_rate","custom_pricing","debit_card_per_transaction_fee","debit_card_rate","international_per_transaction_fee","international_rate","international_surcharge","maintenance_fee","monthly_subscription_fee","payouts_per_transaction_fee","per_transaction_fee","per_transaction_rate","rate_string"]},"attributes":{"type":"object","properties":{"value":{"oneOf":[{"type":"number","example":25},{"type":"boolean"}]},"currency":{"type":"string","enum":["USD"]}}}}}}}},"application_event":{"type":"object","properties":{"application_id":{"type":"string","example":"046c5273-cc55-4047-b9ca-26263a9763ac","description":"Kompliant-generated unique identifier for the partner."},"event":{"type":"string","enum":["created","submitted","decision_analytics_completed","application_data_updated","verification_status_updated","application_status_updated","decision_document_generated"]}}},"application_event_propay":{"type":"object","properties":{"application_id":{"type":"string","example":"046c5273-cc55-4047-b9ca-26263a9763ac"},"event":{"type":"string","enum":["propay_submitted"]}}},"application_event_heartland":{"type":"object","properties":{"application_id":{"type":"string","example":"046c5273-cc55-4047-b9ca-26263a9763ac"},"event":{"type":"string","enum":["heartland_credentials_received"]}}}},"parameters":{"application_id":{"name":"application_id","in":"path","required":true,"description":"String generated by Kompliant used to identify an application.","schema":{"type":"string"}},"document_id":{"name":"document_id","in":"path","description":"Id of the document to retrieve","required":true,"schema":{"type":"string"}}}},"x-readme":{"explorer-enabled":true,"proxy-enabled":true}}