Application Section Queries & Mutations

Owned by Admoll Adefemi
Dec 03, 2024
19 min read

applicationById

This query retrieves detailed information about an application based on the provided ID.

Input Variable
The query requires a single input variable:

applicationByIdId (ID!): The unique identifier of the application for which you want to retrieve information.

query ApplicationById($applicationByIdId: ID!) { applicationById(id: $applicationByIdId) { amount applicationNumber id credit { creditBureauScoreReport } } }
{ "applicationByIdId": "" // application ID }
{ "data": { "applicationById": { "amount": 15000, "applicationNumber": "APP123456", "id": "j23hd87hbduhef4y", "credit": { "creditBureauScoreReport": { "score": 780, "reportUrl": "<https://example.com/credit-report>" } } } } }

Application

This query retrieves information about an application based on its application number.

Input Variables

  • applicationNumber (String!): The application number for which you want to retrieve information.

In the Sample Response, the query returns information about the application with the provided application number. The account field includes the following details:

  • id (String): The unique identifier of the account associated with the application.

  • name (String): The name of the application.

  • isMultiUser (Boolean): Indicates whether the application supports multiple users.

To Initiate an Application

The initiateApplication mutation allows you to initiate a new application for a loan. This mutation requires a CustomerCreateApplicationInput input variable, which contains the necessary details for the loan application. The mutation will return a response indicating the success status and the application ID if the initiation is successful.

Traces

The Traces query allows you to query and retrieve traces related to a specific application. Traces represent events or actions associated with an application and can provide valuable insights.

This query retrieves a list of traces associated with a specific application.

Input Variables

  • applicationByIdId (ID!): The unique identifier of the application for which traces are requested.

  • after (ConnectionCursor): Returns the list of items in the set, after the specified cursor.

  • before (ConnectionCursor): Returns the list of items in the set, before the specified cursor.

  • first (ConnectionLimitInt): Returns the first N elements from the list.

  • last (ConnectionLimitInt): Returns the last N elements from the list.

  • orderBy (ApplicationTraceOrderByInput): Specifies the order in which traces should be returned.

To Approve Manual Review Application

To approve an application that requires manual review. The approveManualReviewApplication mutation takes an input variable, which includes the applicationId of the application to be approved and an optional comment.

In the sample response, the application with the ID "ck1xcu4by6let0842lecvvrlv" was successfully approved, and the approved field in the response is set to true. The id of the approved application is also returned in the response.

To Set Application for Manual Review

This mutation is used to set an application for manual review with the provided input variables. It takes an ApplicationStageInput object as input and returns the approved status along with the id of the updated application.

The response will include a data object containing the result of the mutation. Inside the setManualReviewApplication field, there will be two fields:

  • approved: A boolean value indicating whether the manual review for the application was approved or not.
    application: An object containing the details of the updated application. In this case, it includes the id of the

  • application that underwent manual review.

Please note that the actual values of approved and id in the response may vary based on the logic of your application and the outcome of the manual review process.

generateCustomApplicationOffers

This mutation allows you to generate custom application offers based on the provided input parameters. It takes an ApplicationStageInput object as input and returns a GenerateApplicationOffersPayload object as the response.

Input Variable: ApplicationStageInput

The ApplicationStageInput input type represents the parameters required to generate custom application offers. It includes the following fields:

  • applicantId (ID!): The ID of the applicant for whom the custom application offers are being generated.

  • selectedJobIds ([ID!]!): An array of IDs representing the selected job positions for which offers are being generated.

  • customMessage (String): An optional custom message to be included in the offers.

In the sample response, the generateCustomApplicationOffers mutation returns an object with an id representing the generated application offers' ID and an array of offers containing individual offer objects. Each offer object includes an id, jobTitle, salaryOffer, and an array of benefits.

Modifying Processing Fee

Modifies the processing fee for a specific application.

** Input Variables**
The mutation requires an input variable of type ModifyProcessingFeeInput.

  • applicationId: The unique identifier of the application for which the processing fee needs to be modified.

  • processingFee: The new processing fee amount to be set for the application.

In the sample response, the modifyProcessingFee mutation returns feedback on the modification, the application number, and a boolean indicating the success status of the operation.

Apply Moratorium On Application

Applies a moratorium on a specific application for a specified number of periods.

Input Variables
The ApplyMoratoriumOnApplicationInput input object consists of the following fields:

  • applicationId: ID of the application on which to apply the moratorium. (Required)

  • numberOfPeriods: Number of moratorium periods to apply. (Required)

Sample Response
The response of the mutation includes the following fields:

  • application: The updated application object with its custom application form.

  • mbsFeedback: Feedback related to the mutation request, including the requestId, status, and message.

  • success: Indicates whether the mutation was successful.

Update Application Loan Duration

This mutation is used to update the loan duration of a specific loan application.

Input Variable
The mutation requires an input variable of type UpdateApplicationLoanDurationInput, which includes the following fields:

  • applicationId: ID of the application to be updated.

  • durationType: Type of loan duration (e.g., "DAILY" "WEEKLY" "MONTHLY" "ANNUALLY" "ONE_OFF").

  • loanDuration: New duration value for the loan.

Sample Response
In this response, the application field provides the updated application details, including the new loanDuration. The updated field is a boolean indicating whether the update was successful.

Modify Application Interest Rate

Modifies the interest rate of a loan application.

Input Variables

  • input: An object containing the following fields:

  • applicationId (String): The unique identifier of the application for which the interest rate needs to be modified.

  • calcBy (String): The method by which the interest rate is calculated. Possible values: "PERCENTAGE", "FIXED", etc.

  • interestRate (Float): The new interest rate to be set for the application.

In the sample response, the success field indicates whether the modification was successful or not, and the application field provides the application number of the modified application.

To Add Application Comment

This mutation allows you to add a comment to an application.

Input Variable
To execute the AddApplicationComment mutation, you need to provide the following input variable:

  • applicationId (String): The unique identifier of the application to which the comment should be added.

  • comment (String): The content of the comment to be added to the application.

Sample Response
Upon successfully adding a comment to the application, the API will return a response with the following structure:

  • application (Object): Contains the updated application information.

  • id (String): The unique identifier of the application to which the comment was added.

  • success (Boolean): Indicates whether the comment addition was successful (true) or not (false).

To Skip Card Collection

This mutation allows you to skip a card collection for a specific application.

Input Variable

  • input: An object containing the necessary data to skip a card collection.

    • applicationId (String): The ID of the application for which you want to skip the card collection.

The response will contain information about the skipped card collection.

In the response, the application field will provide the ID of the skipped application, and the success field will indicate whether the card collection was successfully skipped (true) or not (false).

Delete Application Document

The DeleteApplicationDocument mutation allows you to delete a document associated with a specific application.

Input Variables

  • input: An object containing the following fields:

    • applicationId (String, required): The unique identifier of the application whose document you want to delete.

    • bucket (String, required): The name of the storage bucket where the document is stored.

    • key (String, required): The key or path of the document within the storage bucket.

Response
The deleteApplicationDocument mutation returns an object with the following fields:

  • application (Object): An object representing the application from which the document was deleted. It contains the following field.

  • id (String): The unique identifier of the application.

  • success (Boolean): Indicates whether the deletion was successful (true) or not (false).

In the sample response, the document associated with the application with ID "12345" has been successfully deleted from the bucket "jhb67ghih8" with the key "5jynuertyuill". The success field indicates that the deletion operation was successful.

Delete Customer Document

This mutation allows you to delete a customer document associated with a specific application.

Input Variables
You need to provide the following input variable:

  • applicationId: The unique identifier of the application associated with the document.

  • bucket: The identifier of the storage bucket where the document is stored.

  • key: The unique key or filename of the document within the storage bucket.

Sample Response
The response of the deleteCustomerDocument mutation will have the following structure:

  • application: An object containing information about the application associated with the deleted document.

    • applicationNumber: The application number of the associated application.

  • success: A boolean indicating whether the document deletion was successful (true) or not (false).

Assign Application To Merchant User

Assigns an application to a specific merchant user account.

Input Variables

  • input (required): An object containing the necessary information to perform the assignment.

    • applicationId (required): The unique identifier of the application to be assigned.

    • assignTo (required): The accountUser ID of the merchant user to whom the application will be assigned.

In this Sample Response, the application was successfully assigned to the specified merchant user account, and the response indicates success along with a relevant message. If the assignment were to fail, the success field would be false, and the message field would provide information about the reason for the failure.

To Unassign Application

This mutation allows you to unassign an application by providing the applicationId.

Input Variables

  • input: The input object for the UnassignApplication mutation.

    • applicationId (String, required): The unique identifier of the application you want to unassign.

Mp Set Application Bank Account

This mutation updates the bank account information for a specific application. It takes an input object as a parameter and returns details about the success of the operation, a message indicating the outcome, the ID of the updated application, and the updated bank account details.

Input Variables:

  • input (MpSetApplicationBankAccountInput!): The input object containing the necessary information to update the bank account for the application.

    • applicationId (String!): The ID of the application for which the bank account needs to be updated.

    • bankAccountId (String!): The ID of the bank account to be associated with the application.

    • newBankAccount (MpBankAccountInput): Optional. The new bank account information to update. If null, the existing bank account associated with the application remains unchanged.

Sample Response

The mutation returns an object with the following fields:

  • success (Boolean): Indicates whether the mutation was successful.

  • message (String): A message describing the result of the mutation.

  • applicationId (String): The ID of the updated application.

  • bankAccount (MpBankAccount): Details of the bank account associated with the application.

    • accountName (String): The name associated with the bank account.

    • accountNumber (String): The account number associated with the bank account.

    • id (String): The ID of the bank account.

    • bank (MpBank): Details of the bank associated with the bank account.

      • name (String): The name of the bank.

To Store Rejected Application

The storeRejectedApplication mutation allows you to store information about a rejected loan application in the system. This mutation requires an input object with specific fields to provide the necessary information for storing the rejected application.

Input Variable
The RejectedApplicationInput object contains the following fields:

  • clientId (String!): The unique identifier of the client associated with the rejected application. (Required)

  • amount (Float!): The requested loan amount in a decimal format. (Required)

  • loanDuration (Int!): The loan duration in months. (Required)

  • reason (String!): The reason for rejecting the loan application. (Required)

If the mutation is successful, it will return an object containing the id of the stored application.

To Generate Application Offers

The generateApplicationOffers mutation allows you to generate offers for a specific application stage and store it in the system. This API is designed to be used in the context of an application management system, where you can create offers and associate them with a particular application.

The response will include the application object, containing the id field.

To Complete Application

The completeApplication mutation is used to mark an application as complete and provide a comment on the application stage. This mutation takes an input variable ApplicationStageInput containing the applicationId and a comment. After completion, the approved field and application information will be returned as part of the response.

Response Description

  • approved: A boolean indicating whether the application was approved (true) or not (false).

  • application: An object containing information about the completed application.

  • id: The unique identifier of the completed application.

To Complete External Bank Statement Request

The completeExternalBankStatementRequest mutation allows you to complete an external bank statement request for a specific application.

In the sample response, the success field indicates whether the bank statement request was successfully completed. The application field contains the ID of the application for which the bank statement request was completed.

To Get Applicant CreditScore

getApplicantCreditScore allows you to retrieve the <<glossary:Credit Score>> of an applicant based on their application stage information.

Upon a successful request, you will receive a response with the credit score information of the applicant under the application field.

To Complete Bank Statement Request

This allows you to complete a bank statement request for an application. It takes an input variable of type CompleteBanksStatementInput as an argument and returns information about the success of the request and the application's ID.

In the sample response, the success field indicates whether the bank statement request was completed successfully. The application field contains the application's ID, which can be used for further reference or queries.

Setting Application Bank Account

The setApplicationBankAccount mutation is used to update the bank account information associated with a specific application. It takes an ApplicationBankStageInput object as input, which contains the necessary information to perform the update. The mutation will return a response indicating the success of the operation and the updated application's ID.

In the sample response above:

  • The "success" field indicates whether the bank account update was successful (true) or not (false).

  • The "application" field contains the updated application's ID ("ck2ows4pc8g6i0842t5zsl61d" in this example).

To Reject a Single Manual Review Application

The rejectManualReviewApplication mutation is used to reject a manual review application based on the input provided.

In the response:

  • approved: A boolean indicating whether the application was approved (false as it was rejected).

  • application: An object containing the details of the application that was rejected.

  • id: The ID of the rejected application.

Please note that the actual response may contain additional fields depending on your GraphQL schema configuration, but the provided sample response covers the essential information for this mutation.

Initiating Bank Statement Request

Use this mutation to initiate a request for a bank statement.

To Change Application Policy

The changeApplicationPolicy mutation is used to update the policy associated with an application. This mutation allows you to change the policy by providing the application ID, the new policy ID, and an optional comment to describe the reason for the change.

To Reject One or More Manual Review Applications

The rejectManualReviewApplications mutation is used to reject one or more manual review applications based on the provided input data. Manual review applications are typically those that require human intervention or additional scrutiny before they can be approved or denied.

Please note that this is a sample response and the actual data will vary based on the application ID that was rejected.

To Initiate Application

The initiateApplication mutation allows you to initiate a new application for a loan. This mutation requires a CustomerCreateApplicationInput input variable, which contains the necessary details for the loan application. The mutation will return a response indicating the success status and the application ID if the initiation is successful.

Upload Supporting Document

Use this mutation to upload a supporting document for a user.

Content-type: multipart/form-data

Input Variable

  • input: An object of type SupportingDocumentInput containing the following fields:
    file: The actual document file to be uploaded. It must be of type Upload.
    documentName: A descriptive name for the document.
    documentType: The type or category of the document.
    userId: The ID of the user associated with the document.

Uploading Requested Supporting Document

This mutation allows you to upload a requested supporting document for a specific request. The uploadRequestedSupportingDocument mutation takes an input variable, which contains the necessary data for the document upload. Upon successful upload, the API will return a response indicating the success status along with the application ID.

Approving Updated Loan Amount

This mutation allows approving or rejecting an updated loan amount request for a specific loan application.

To Request for Supporting Document

The requestSupportingDocument mutation is used to request supporting documents for a specific application. It allows the user to specify the application ID, the type of documents required, and an optional comment for the request.

To Review Supporting Documents

This mutation allows users to review supporting documents associated with an application.

To Update Application Details

The updateApplicationDetails mutation allows you to update specific details of an existing application. It takes an input variable of type UpdateApplicationDetailsInput and returns information about the update, including the application's unique identifier (id) and whether the update was successful (updated).

In this sample response, the updated field is set to true, indicating that the update was successful. The application field contains the idof the updated application. If the updated field were false, it would indicate that the update failed or there were no changes made to the application details.

Approving Manual Review Applications

The approveManualReviewApplications mutation is used to approve manual review applications based on the provided input variables. This mutation allows you to approve one or more manual review applications in a single request.

The sample response indicates that the manual review application with the ID "ck1xcu4by6let0842lecvvrlv" has been successfully approved. The specific data returned in the response may vary based on the implementation and the data structure of the application entity.

Adding Application Meta

The addApplicationMeta mutation allows you to add metadata to a specific application. Metadata can be used to store additional information related to an application. This mutation takes an input variable of type ApplicationMetaInput containing the necessary data for adding metadata.

saveCustomApplicationForm

saveCustomApplicationForm(input: SaveCustomApplicationFormInput!): CustomApplicationFormPayload!

The saveCustomApplicationForm mutation that allows you to save the customer's application data from the custom application forms created from the admin portal.

Input Fields for SaveCustomApplicationFormInput Mutation
The input field takes an object of type SaveCustomApplicationFormInput containing the following fields:

applicationId ID <span style="color: brown;">Required</span>

The ID of an application.

data JSON! <span style="color:brown;">Required</span>

The application data of the custom application form.

Sample Input & Sample Responses

latestApplicationFormData

latestApplicationFormData(input: LatestApplicationFormDataInput!): CustomApplicationFormPayload

The latestApplicationFormData query that fetch the customer's application data from the custom application forms created from the admin portal.

Input Fields for LatestApplicationFormDataInput Query
The input field takes an object of type LatestApplicationFormDataInputcontaining the following fields:

customerId String <span style="color:brown;">Required</span>

The ID of the customer.

Response Fields for LatestApplicationFormDataInput Mutation
The input field takes an object of type LatestApplicationFormDataInput containing the following fields:

success Booelan <span style="color:brown;">Required</span>

Whether or not the application data was fetched.

data JSON

The data of the application.