/api/v1/banking/submit/personal

API Method: POST /api/v1/banking/submit/personal

Description:

This API endpoint allows the creation and submission of a personal banking services application. It is used for onboarding individuals who require personal banking services, such as agents or sole proprietors, as part of the payment processing system. The application includes personal information, contact details, and identification data, which are essential for verification and setting up the individual’s payment and settlement profile.

Request:

• HTTP Method: POST
• Endpoint: /api/v1/banking/submit/personal
• Content-Type: application/json

Request Body Parameters:

The request body must be in JSON format and include the following fields:

• agentPayoutProfileId (required):
  A unique identifier for the payout profile associated with the agent or individual.

  • Type: int32
  • Example: "agentPayoutProfileId": 1001

• firstName (required):
  The first name of the individual.

  • Type: string
  • Example: "firstName": "John"

• lastName (required):
  The last name of the individual.

  • Type: string
  • Example: "lastName": "Doe"

• middleName (optional):
  The middle name of the individual.

  • Type: string
  • Example: "middleName": "Michael"

• address (required):
  The residential address of the individual.

  • Type: string
  • Example: "address": "123 Elm Street"

• city (required):
  The city where the individual resides.

  • Type: string
  • Example: "city": "Los Angeles"

• state (required):
  The state or region where the individual resides.

  • Type: string
  • Example: "state": "CA"

• zip (required):
  The ZIP code or postal code of the individual's address.

  • Type: string
  • Example: "zip": "90001"

• phone (required):
  The phone number of the individual.

  • Type: string
  • Example: "phone": "+1-555-123-4567"

• ssn (required):
  The individual's Social Security Number (SSN) for identification and verification.

  • Type: string
  • Example: "ssn": "123-45-6789"

• birthday (required):
  The individual's date of birth in ISO 8601 format.

  • Type: date-time
  • Example: "birthday": "1985-05-15T00:00:00Z"

• email (required):
  The email address of the individual for communication purposes.

  • Type: string
  • Example: "email": "[email protected]"

• agentId (optional):
  A unique identifier for the agent submitting the application, if applicable.

  • Type: int32
  • Example: "agentId": 5678

Response:

• Status Code:

  • 201 Created: If the personal banking services application is successfully created and submitted.
  • 400 Bad Request: If required fields are missing or the request contains invalid data.
  • 500 Internal Server Error: If there is an issue processing the request.

• Response Body:
  The response will contain a confirmation of the submitted application, including an application ID for tracking purposes.

Response Example:

{
  "message": "Personal banking services application submitted successfully.",
  "applicationId": "APP-12345-JD"
}

Example Request:

POST /api/v1/banking/submit/personal
Content-Type: application/json

{
  "agentPayoutProfileId": 1001,
  "firstName": "John",
  "lastName": "Doe",
  "middleName": "Michael",
  "address": "123 Elm Street",
  "city": "Los Angeles",
  "state": "CA",
  "zip": "90001",
  "phone": "+1-555-123-4567",
  "ssn": "123-45-6789",
  "birthday": "1985-05-15T00:00:00Z",
  "email": "[email protected]",
  "agentId": 5678
}

Use Case:

This API is used for submitting personal information as part of a banking services application for agents, sole proprietors, or individuals seeking payment processing services. The provided information is used to verify identity, set up banking profiles, and process payouts or settlements.