# Credit Application Submission POST /partner/v2/shops/:shop_uuid/applications The example below includes all parameters that can be sent in the POST /application request. Please note, that not all parameters listed below are required. For examples of required parameters for this request, refer to the Direct API Guide. A credit application can be submitted with minimum dataset capturing mandatory fields, partners have the option to submit a detailed application to capture more information regarding the application itself. The request payload consists of the following sub-objects: - credit_application: monthly income, product code and other credit-related data - customer: customer\'s identity code, name and gender - customer_addresses: customer\'s address details - customer_contact: customer\'s email and phone number - customer_identification: the type of customer identification document and its number - purchase: details about the purchased items - consents: customer's consent related to the credit application process. - customer_consents: customer's consent for receiving data - customer_ubos: customer\'s Ultimate Beneficial Ownership (UBO) information - customer_pep: required details if the customer is PEP (politically exposed person) - customer_self_ubo: whether the customer applying for credit is also the UBO - else_ubo_pep: captures information about individuals who are UBOs of the loan but are not the customers applying themselves and are also identified as PEPs - customer_consent: customer's consent for processing of their individual data - partner_urls: partner/merchant's callback URL - additional_details: additional custom parameters that are related to the credit application. Endpoint: POST /partner/v2/shops/{shop_uuid}/applications Security: bearerAuth ## Path parameters: - `shop_uuid` (string, required) The unique identifier of the shop. Example: "38571c75-2590-4c81-8252-531613c96363" ## Request fields (application/json): - `credit_application` (object) - `credit_application.product_code` (string, required) Product code. - `credit_application.amount` (number, required) Financing amount. - `credit_application.period` (integer, required) Financing period in months. Options depend on the particular product. - `credit_application.payment_day` (integer) Payment day. Minimum value - 1, maximum value - 28. - `credit_application.down_payment_amount` (number) Down payment amount. Required if down payment is to be used. Note that down payment is required in Latvia for Hire Purchase payment products for amounts over 1400 EUR. - `credit_application.payout_account_number` (string) The account number to which the credit amount will be transferred. IBAN bank account number for payout. Should be valid bank account number in IBAN format. Required if payout to customer. - `credit_application.einvoice_account_number` (string) The account number to which e-invoices are to be sent. Required if payout to customer. - `credit_application.credit_purpose` (string) The purpose for which credit is to be granted. - `credit_application.monthly_income` (number) Monthly income. Required for Inbank Hire Purchase in Estonia. - `credit_application.monthly_financial_obligations` (number) Amount of monthly financial obligations. Required for Inbank Hire Purchase in Estonia. - `credit_application.income_source` (string) Main source of income. Enum: "employment_indefinite", "employment_definite", "free_for_task", "self_employed", "pension", "disability_living_allowance", "farmer", "lease_income" - `credit_application.employment_start` (string) Employment start year and month. YYYY-MM. Accepts also - YEAR_or_earlier (e.g 2012_or_earlier). - `credit_application.employment_end` (string) Employment end year and month. YYYY-MM. Accepts also - YEAR_or_later (e.g 2022_or_later). - `credit_application.civil_status` (string) Civil status. Enum: "single", "married_w_common_property", "married_w_division_property", "living_w_partner" - `credit_application.housing_status` (string) Housing status. Enum: "living_w_parents", "tenant", "owning_house_apartment" - `credit_application.dependants_count` (integer) Number of dependants the customer has. Required for Inbank Hire Purchase in Latvia. - `credit_application.underage_dependants_count` (integer) Number of underage dependants the customer has. - `credit_application.monthly_household_costs` (number) Amount of monthly household costs. - `credit_application.employer_registry_code` (string) Employer NIP. - `credit_application.employer_name` (string) Employer name. - `credit_application.employer_phone` (string) Employer phone number. - `credit_application.employment_duration` (string) Duration of current employment in years. - `credit_application.employment_position` (string) Customer employment position. - `credit_application.salesperson_reference` (string) Identifier of the sales person as it should appear on reports. - `credit_application.pos_session_uuid` (string) Unique identifier of EPOS session - `credit_application.previous_uuid` (string) Unique identifier of previous session - `customer` (object) - `customer.identity_code` (string, required) Customer identity code/PESEL. Must be present and be valid according to current country's identity code rules, where country is taken from application configuration. - `customer.first_name` (string, required) Customer first name. See validation rules below. - `customer.last_name` (string, required) Customer last name. See validation rules below. - `customer.gender` (string) Gender of the customer. Enum: "m (male)", "f (female)" - `customer.residency` (string) Two letter code of the country of customer's residency. - `customer.tax_residency` (string) Two letter code of the country of customer's tax residency. - `customer.pep_status` (string) Required for Inbank Hire Purchase. Not required for Split into parts. Enum: "not_pep", "pep_in_local_country", "pep_in_eu", "pep_in_third_country" - `customer.pep_position` (string) The position which the politically exposed person is holding. Available options - In Estonia - PRESIDENT,PRIME_MINISTER,MINISTER,PARLIAMENT,POLITICAL_PARTY_BOARD,STATE_SECRETARY, SECRETARY_GENERAL,AUDIT_GENERAL,CHANCELLOR_JUSTICE,SUPREME_COURT_JUDGE, GENERAL_PROSECUTOR,NATIONAL_BANK_SUPERVISORY_BOARD,AMBASSADOR,COMMANDER, STATE_CONTROLLED_SUPERVISORY_BOARD,STATE_FOUNDATION_SUPERVISORY_BOARD,CITY_MAYOR, MUNICIPALITY_MAYOR,STATE_AUTHORITY_DIRECTOR,STATE_ARCHIVIST, FINANCIAL_INSPECTION_SUPERVISORY_BOARD In Latvia - PRESIDENT,MUNICIPALITY_MAYOR,PRIME_MINISTER,MINISTER, MINISTER_DEPUTY,GOVERNMENT_OFFICIAL,PARLIAMENT,POLITICAL_PARTY_SUPERVISORY_BOARD, CONSTITUTIONAL_COURT_JUDGE,SUPREME_COURT_JUDGE,REGIONAL_COURT_MEMBER, AUDITOR_COURT_BOARD,CENTRAL_BANK_BOARD,AMBASSADOR,HIGH_RANK_OFFICER, STATE_CONTROLLED_SUPERVISORY_BOARD,INTERNATIONAL_ORGANIZATION_MEMBER In Poland - PRESIDENT,PRIME_MINISTER,VICE_PRESIDENT,MINISTER, DEPUTY_MINISTER,STATE_SECRETARY,LEGISLATIVE_BODY_MEMBER,POLITICAL_PARTY_BOARD, STATE_COURT_JUDGE,SUPREME_COURT_JUDGE,CONSTITUTIONAL_TRIBUNAL_COURT_JUDGE, SUPREME_ADMINISTRATIVE_COURT_JUDGE,APPEAL_COURT_JUDGE,JUDICAL_BODY_MEMBER, AUDITOR_COURT_MEMBER,CENTRAL_BANK_MANAGEMENT_BOARD,AMBASSADOR,ARMED_FORCE_OFFICER, STATE_CONTROLLED_BODY_MEMBER,STATE_FOUNDATION_BODY_MEMBER, INTERNATIONAL_ORGANIZATION_MEMBER,STATE_AUTHORITY,REGIONAL_OFFICE_GENERAL_DIRECTOR, PERSONS_PERFORMING_PUBLIC_FUNCTIONS - `customer.is_ubo` (boolean) Whether the customer is the ultimate beneficiary of the credit. If set to false, Inbank cannot offer credit to this customer. Required for Inbank Hire Purchase. Not required for Split into parts. - `customer.communication_language` (string) The preferred communication language. 2-digit code, ISO 639-1. Enum: "aa", "ab", "ae", "af", "ak", "am", "an", "ar", "as", "av", "ay", "az", "ba", "be", "bg", "bh", "bi", "bm", "bn", "bo", "br", "bs", "ca", "ce", "ch", "co", "cr", "cs", "cu", "cv", "cy", "da", "de", "dv", "dz", "ee", "el", "en", "eo", "es", "et", "eu", "fa", "ff", "fi", "fj", "fo", "fr", "fy", "ga", "gd", "gl", "gn", "gu", "gv", "ha", "he", "hi", "ho", "hr", "ht", "hu", "hy", "hz", "ia", "id", "ie", "ig", "ii", "ik", "io", "is", "it", "iu", "ja", "jv", "ka", "kg", "ki", "kj", "kk", "kl", "km", "kn", "ko", "kr", "ks", "ku", "kv", "kw", "ky", "la", "lb", "lg", "li", "ln", "lo", "lt", "lu", "lv", "mg", "mh", "mi", "mk", "ml", "mn", "mr", "ms", "mt", "my", "na", "nb", "nd", "ne", "ng", "nl", "nn", "no", "nr", "nv", "ny", "oc", "oj", "om", "or", "os", "pa", "pi", "pl", "ps", "pt", "qu", "rm", "rn", "ro", "ru", "rw", "sa", "sc", "sd", "se", "sg", "si", "sk", "sl", "sm", "sn", "so", "sq", "sr", "ss", "st", "su", "sv", "sw", "ta", "te", "tg", "th", "ti", "tk", "tl", "tn", "to", "tr", "ts", "tt", "tw", "ty", "ug", "uk", "ur", "uz", "ve", "vi", "vo", "wa", "wo", "xh", "yi", "yo", "za", "zh", "zu" - `customer.occupation` (string) The position which the customer is holding at their workplace. Available options - specialist,worker,self_employed,top_manager,middle_manager,bottom_manager,student,retired,other. - `customer.birth_date` (string) Customer's birth date. - `customer.birth_place` (string) Customer's birth place. - `customer_addresses` (object) - `customer_addresses.type` (string) Type of customer address. If more than one address is added, a legal type address is required and set as primary. If one address is added without type, it is set as primary. Enum: "legal", "contact" - `customer_addresses.country` (string, required) Customer address country. ISO 3166-1 alpha-2, codes. Enum: "EE", "LV", "LT", "RU", "FI", "NO", "SE", "PL", "CZ", "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CY", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "ET", "FK", "FO", "FJ", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LB", "LS", "LR", "LY", "LI", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PT", "PR", "QA", "RE", "RO", "RW", "SH", "KN", "LC", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" - `customer_addresses.street` (string, required) Customer address street name, E.g. Niine. - `customer_addresses.county` (string) Customer address county name. E.g. HARJU MAAKOND - `customer_addresses.parish` (string) Customer address parish/municipality name. E.g. HARJU - `customer_addresses.township` (string) Customer address township name. E.g. HARJU MAAKOND - `customer_addresses.house` (string) Customer address house number, E.g. 11. - `customer_addresses.apartment` (string) Customer address apartment number, E.g. 4A. - `customer_addresses.city` (string) Customer address city name, E.g. Tallinn. - `customer_addresses.zip_code` (string, required) Customer address postal code, E.g. 10414. - `customer_addresses.provider` (string) Name of the person providing the customer address data - `customer_contact` (object) - `customer_contact.mobile` (string) Customer contact mobile number, i.e. +37253630000, 53630000. Not required only if the email parameter is sent. Must be new or unique to current customer. - `customer_contact.email` (string) Customer contact email address. Not required only if the mobile parameter is sent. Must be new or unique to current customer. - `customer_contact.phone` (string) Customer phone number. - `customer_identification` (object) - `customer_identification.document_type` (string, required) Customer identification document type. Enum: "id_card", "passport", "residence_permit", "foreigner_passport", "commercial_registry_statement", "online_id_card", "online_mobile_id", "bank_link", "partner_bank_payment", "foreigner_id_card", "drivers_license", "australian_passport" - `customer_identification.document_number` (string, required) Customer identification document number. Must be new or unique to current customer and be valid for current country and document_type. - `customer_identification.document_valid_from` (string) Must be in the past and be before the date of valid_to parameter. - `customer_identification.document_valid_to` (string) Must be in the future and be after the date of valid_from parameter. - `customer_identification.document_valid_to_not_applicable` (boolean) Indicates that the 'valid to' date does not apply to the customer identification document. - `customer_identification.identification_method` (string) Method of verification used to confirm the customer's identification document. - `customer_identification.identification_location` (string) Location where customer identification document was issued. - `customer_identification.issuer` (string) Name of authority who issued the customer identification document - `customer_consents` (object) - `customer_consents.marketing` (boolean) Whether customer has given consent to receive marketing notifications or not. - `customer_consents.marketing_email` (boolean) Whether customer has given consent to receive marketing emails or not. - `customer_consents.marketing_sms` (boolean) Whether customer has given consent to receive marketing sms on their phone or not. - `customer_consents.marketing_post` (boolean) Whether customer has given consent to receive marketing posts on social media or not. - `customer_consents.marketing_phone` (boolean) Whether customer has given consent to receive marketing calls or not. - `customer_consents.product_notifications` (boolean) Whether customer has given consent to receive notifications related to products or not. - `customer_consents.operational_contact_email` (boolean) Whether customer has consented to be contacted via email by the company regarding any operational issues or not. - `consents` (array) Array of all types of consents related to the credit application process - `consents.type` (string, required) Consent type. The complete list of required consents will be provided by Inbank. Consents required for Split into parts in Estonia - SERVICE_AGREEMENT_SLICE_EE, ESERVICES_AGREEMENT. Consents required for Split into parts in Latvia - ESERVICES_AGREEMENT. Enum: "EMTA_REGISTRY_QUERY", "CLICK_ACCEPT", "ESERVICES_AGREEMENT", "DATA_PROCESSING", "PRIVACY_POLICY", "MARKETING_EMAIL", "MARKETING_PHONE", "MARKETING_POST", "MARKETING_SMS", "MARKETING_SOCIALMEDIA", "MARKETING_MOBILEAPP", "PRODUCT_NOTIFICATION", "NO_PEP_CONFIRMATION", "BO_CONFIRMATION", "PENSION_REGISTRY", "TERMS_AND_CONDITIONS_CREDIT_CARD", "SERVICE_AGREEMENT_HP_EE", "TOKEN_IO_PAYMENT_AGREEMENT", "ACCOUNT_NOTIFICATION", "PIS_CONFIRMATION", "AIS_AS_CONFIRMATION", "RENTAL_AGREEMENT" - `consents.value` (boolean, required) Whether the customer has given their consent or not. - `consents.text` (string, required) The precise consent text to which the customer is agreeing. - `consents.valid_from` (string) Date from which customer consent is valid - `consents.attachment` (object) - `consents.attachment.uuid` (string) Unique attachment identifier of the document/image for which consent was taken. - `purchase` (object) - `purchase.purchase_reference` (string) Unique reference number of the shopping cart or order at the partner side. Not required only if the description parameter is sent. - `purchase.id` (string) Unique identificator of the shopping cart or order at the partner side. - `purchase.description` (string) Textual description of the order or shopping cart, meaningful for customers. Not required only if the purchase_reference parameter is sent. - `purchase.additional_details` (object) Any additional details about the purchase order that are not covered with predefined parameters. - `purchase.items` (array) Array of items in the order/shopping cart. - `purchase.items.item_reference` (string) Item reference provided by partner. - `purchase.items.id` (string) Item identificator provided by partner. - `purchase.items.type` (string) Item type. Some types require additional information/validations. Options - 'product', 'service', 'vehicle'. - `purchase.items.description` (string) Textual name of the item. - `purchase.items.quantity` (integer) Quantity of items in this row. - `purchase.items.amount` (number) Price of item(s) in this row (row sum). - `purchase.items.serial_number` (string) Serial number of the purchased item. - `purchase.items.url` (string) Link to the purchased item. - `purchase.items.image_url` (string) Link to an image of the purchased item. - `purchase.items.additional_details` (object) Any additional details about the individual purchased item that are not covered with predefined parameters. To be added in key-value pair format. - `purchase.items.vehicle_vin` (string) Vehicle identification number of the purchased vehicle. - `purchase.items.vehicle_licence_plate` (string) License plate of the purchased vehicle. - `purchase.items.vehicle_make` (string) Brand of the purchased vehicle. - `purchase.items.vehicle_model` (string) Model of the purchased vehicle. - `purchase.items.vehicle_registration_date` (string) Registration date of the purchased vehicle. - `customer_pep` (array) - `customer_pep.valid_from` (string) Date from which PEP (Politically exposed person) status is valid for the customer. - `customer_pep.location` (string) Area/scope of customer's PEP status. Enum: "NO", "LOCAL", "EEA", "OTHER" - `customer_pep.position` (string) The position which the politically exposed person is holding. - `customer_pep.relation` (string) Relation of the customer with the politically exposed person. Enum: "CUSTOMER_IS_PEP", "ASSOCIATE_IS_PEP", "FAMILY_MEMBER_IS_PEP" - `customer_pep.time` (string) Duration for which the PEP status has been held. Enum: "CURRENTLY", "LESS_THAN_YEAR", "MORE_THAN_YEAR" - `customer_self_ubo` (object) - `customer_self_ubo.value` (boolean) Whether the customer applying for credit is also the UBO (Ultimate Beneficial Owner). - `customer_ubos` (array) - `customer_ubos.full_name` (string) Full name of the ultimate beneficial owner. - `customer_ubos.residency` (string) Residency of the ultimate beneficial owner. - `customer_ubos.identity_code` (string) Identity code. - `customer_ubos.birth_place` (string) Place of birth of the ultimate beneficial owner. - `customer_ubos.birth_date` (string) Date of birth of the ultimate beneficial owner. - `customer_ubos.pep_status` (string) PEP (Politically exposed person) status of the ultimate beneficial owner. - `customer_consent` (array) Array of consents to consents that are directly linked to the customer's individual permissions or agreements with Inbank. - `else_ubo_pep` (object) - `else_ubo_pep.ubo` (object) - `else_ubo_pep.ubo.ubo_first_name` (string) First name of the ultimate beneficial owner. - `else_ubo_pep.ubo.ubo_last_name` (string) Last name of the ultimate beneficial owner. - `else_ubo_pep.ubo.id_code` (string) Identity code. - `else_ubo_pep.pep` (object) - `partner_urls` (object) - `partner_urls.callback_url` (string) The URL to which Inbank will send server-to-server callback notifications on financing process status change events. - `additional_details` (object) Any additional details about the credit application that are not covered with predefined parameters. To be added in key-value pair format. ## Response 201 fields (application/json): - `uuid` (string) Application uuid. Example: "471e6282-3384-412b-af7b-646eb8f04391" - `number` (number) Application reference number. Example: 89002917439 - `status` (string) Session status. Example: "pending" - `productCode` (string) Product code. Example: "example_product" - `amount` (number) Financing amount. Example: 1001 - `period` (integer) Financing period in months. Example: 12 - `downPaymentAmount` (number) Down payment amount. - `paymentDay` (integer) Payment day. Example: 15 - `startDate` (string) Start date. Example: "2020-12-15" - `endDate` (string) End date. Example: "2021-11-15" - `decisionStatus` (string) It can be considered that the application received a positive decision if its decisionStatus is positive. Usually, a new application has decisionStatus as pending until the decision is reached. To receive the application decision, the GET /application endpoint should be polled once a second for a maximum of 30 seconds. Enum: "positive", "negative", "manual_negative", "failed", "income_proof_requested", "pending", "manual" - `decisionMessages` (string) Contain a list of messages to be displayed to the customer on why the application decision received the corresponding status. Example: "Positive decision" - `changedConditions` (boolean) Annual credit cost rate. - `previousUuid` (string) Previous uuid. - `salespersonReference` (string) First name and last name of the sales person as it should appear on reports. Example: "Earl James" ## Response 401 fields (application/json): - `message` (string) Unauthorized Example: "unauthorized" ## Response 403 fields (application/json): - `message` (string) Unauthorized access Example: "User is not authorized to access this resource with an explicit deny" ## Response 404 fields (application/json): - `message` (string) Not Found Example: "not_found" ## Response 422 fields (application/json): - `message` (string) Unprocessable Entity ## Response 500 fields (application/json): - `message` (string) Internal server error Example: "internal_server_error"