# Credit Applications Credit applications are the initial step in the Inbank financing process. Once the application is reviewed and accepted by the customer, a credit contract is created. ## Credit Application Submission - [POST /partner/v3/shops/{shopUuid}/applications](https://docs.inbank.eu/api/full-api-flow/credit-applications/postapplicationsrequest.md): Credit applications are the initial step in the Inbank financing process. Once the application is reviewed and accepted by the customer, a credit contract is created. POST /partner/v3/shops/:shopUuid/applications A credit application is submitted using the POST /partner/v3/:shopUuid/applications endpoint. The credit application contains the credit period and amount, identification data and other information regarding the customer and the purchase. Once the e-shop receives a response to the payment session initiation request with the redirect URL and the UUID of the session, it can forward the data of the credit application to Inbank. To submit credit application data to Inbank, use the POST /partner/v3/shops/:shopUuid/applications request. Request payload consists of several sub-objects: - creditApplication: monthly income, product code and other credit related data - customer: customer\'s identity code, name and gender - customerContact: customer\'s email and phone number - customerAddresses: customer's address details - customerIdentification: the type of customer identification document and its number - consents: customer's consent for processing of their data - purchase: details about the purchased items - partnerUrls: URL for the callbacks about the process status updates. Important note for test environments Document number, phone number and email of one customer cannot be used for another customer. For testing purposes it means that if you introduce a new identity code, you should also generate a new document number, phone number and email address. If you use an existing customer's identity code, you can use both existing and new values for document number, phone number and email address. Due to banking secrecy we cannot indicate the exact reason behind the application failure (e.g. customer with such an email already exists) and will return a generic error: "Error has occurred, contact customer support". The decisionStatus parameter can have the following values: positive, negative, manual_negative, failed, income_proof_required, pending, manual. 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. The decisionMessages contain a list of messages to be displayed to the customer on why the application decision received the corresponding status. If the response includes the income_proof_required decision status, the customer needs to submit their income proof documents to Inbank. The new income_proof_type parameter in the response to POST /applications indicates the manner in which the documents need to be submitted, either via the AIS upload process or the manual upload, or via a manual upload only. Possible values are: - ais_with_fallback_manual_upload_option - the customer can submit their income proof statement via AIS upload process or manual upload. To perform the AIS upload process, you need to redirect the customer to a third party URL. After the AIS upload process is complete, the customer will be redirected back to the flow on your site. - manual_internal_verification - the customer can submit their income proof statement via the manual upload only. Please note that after the AIS upload process, the application might once again receive the income_proof_required decision status with the manual_internal_verification verification type in cases when Inbank needs additional data from the customer to make a decision. ## AIS Bank List Retrieval - [GET /partner/v3/shops/{shopUuid}/account-statements/bank-list](https://docs.inbank.eu/api/full-api-flow/credit-applications/getbanklist.md): GET /partner/v3/shops/:shopUuid/account-statements/bank-list?applicationUuid=applicationUuid In cases when the application receives the income_proof_required decision, the flow needs to include the AIS upload process. The first step is retrieving the list of available banks from which the account statement can be provided via the GET /partner/v3/shops/:shopUuid/account-statements/bank-list API request. The request returns the name, ID and icon URL for each of the available banks. The selection of the banks needs to be displayed to the customer. Please note that the selection of banks is subject to change. ## AIS Upload Session Initiation - [POST /partner/v3/shops/{shopUuid}/account-statements/initiate-retrieval](https://docs.inbank.eu/api/full-api-flow/credit-applications/postsessioninitiation.md): POST /partner/v3/shops/:shopUuid/account-statements/initiate-retrieval Once the customer selects a bank, the AIS upload session can be started using the POST /api/partner/v3/shops/:shopUuid/account-statements/initiate-retrieval API request. The response includes the redirect URL to which the customer should be forwarded to complete the AIS upload process. Once that process is complete, the customer will be redirected back to your site, to the return URL you have indicated in the request body. To learn the new decision which the application has received after the AIS upload and processing, the GET /partner/v3/shops/:shopUuid/applications/:applicationUuid endpoint needs to be polled until there is a new decisionStatus. The usual processing time is within 1 working day. ## Manual Account Statement Upload - [POST /partner/v3/shops/{shopUuid}/applications/{applicationUuid}/attachments](https://docs.inbank.eu/api/full-api-flow/credit-applications/postattachments.md): POST /partner/v3/shops/:shopUuid/applications/:applicationUuid/attachments The account statement file can be forwarded to Inbank via the POST /partner/v3/shops/:shopUuid/applications/:applicationUuid/attachments endpoint. If applied, this endpoint needs to be used instead of the AIS upload related endpoints (steps 2 and 3 of the API request flows). Please note, as income proof documents are processed by Inbank representatives in case of a manual upload, income verification can take some time. To learn the new decision the application has received after the account statement upload and processing, the GET /partner/v3/shops/:shopUuid/applications/:applicationUuid endpoint needs to be polled until there is a new decisionStatus. Request body parameters: Attachments must be submitted as form-data. cURL example: --form "attachments[]=@/path_to/file1.pdf" --form "attachments[]=@/path_to/file2.pdf" ## Application Details - [GET /partner/v3/shops/{shopUuid}/applications/{applicationUuid}](https://docs.inbank.eu/api/full-api-flow/credit-applications/getapplication.md): To check whether a credit application received a decision from Inbank and display the credit offer, the partner needs to get the data of the application and credit details using the GET /partner/v3/shops/:shopUuid/applications/:applicationUuid request. As the decision process might take some time, the endpoint may need to be polled once a second for a maximum of 30 seconds. The response includes the decisionStatus parameter which can have one of the following values: pending, positive, manual_negative, income_proof_required, negative, failed. It can be considered that the application received a positive decision from Inbank if its decisionStatus is positive. Once the partner receives a positive credit decision from Inbank, it can display the offer to the customer. Note that there are situations when the application data may be altered by Inbank systems during processing, in that case the application is also assigned a new UUID and the returned application data contains the attribute changedConditions with value true. The changedConditions attribute informs you if the application has undergone changes or not. If you persist Inbank application UUID in your system - you should always compare the returned UUID with the one you requested and update the UUID on your side respectively. If the response includes the income_proof_required decision status, the customer needs to submit their income proof documents to Inbank. Note for partners integrating in Estonia The income_proof_type parameter in the response indicates the manner in which the documents need to be submitted, either via the AIS upload process or the manual upload, or via a manual upload only. Possible values are: - ais_with_fallback_manual_upload_option - the customer can submit their income proof statement via AIS upload process or manual upload. To perform the AIS upload process, you need to redirect the customer to a third party URL. After the AIS upload process is complete, the customer will be redirected back to the flow on your site. - manual_internal_verification - the customer can submit their income proof statement via the manual upload only. Please note that after the AIS upload process, the application might once again receive the income_proof_required decision status with the manual_internal_verification verification type in cases when Inbank needs additional data from the customer to make a decision. ## Application Approval - [POST /partner/v3/shops/{shopUuid}/applications/{applicationUuid}/accept](https://docs.inbank.eu/api/full-api-flow/credit-applications/postapplicationaccept.md): POST /partner/v3/shops/:shopUuid/applications/:applicationUuid/accept After the credit application receives a positive decision and the credit offer is presented to the customer, they can choose to accept the offer, which is done through the POST /partner/v3/shops/:shopUuid/applications/:applicationUuid/accept endpoint. Accepting the application automatically creates a contract and returns the identifier of the contract in the response. ## Application Cancellation - [POST /partner/v3/shops/{shopUuid}/applications/{applicationUuid}/cancel](https://docs.inbank.eu/api/full-api-flow/credit-applications/postapplicationcancel.md): POST /partner/v3/shops/:shopUuid/applications/:applicationUuid/cancel After the credit application receives a positive decision and the credit offer is presented to the customer, they can choose to cancel their credit application, which is done through the POST /partner/v3/shops/:shopUuid/applications/:applicationUuid/cancel endpoint.