Online Personal Customer Application

This endpoint creates or updates a personal customer profile in the Netevia banking platform. It accepts personal details including identity information, date of birth, contact data, and residential address. On success, it returns the assigned profile ID that can be used in subsequent API calls.

Endpoint

POST /netevia/oma/profile/personal

Authentication

Bearer token required. Obtain via:

POST https://api.banking.netevia.dev/api/auth/v2

Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.

When to use

Use this endpoint when onboarding a new personal customer to the Netevia platform or updating an existing personal profile's information. It is the primary boarding entry point for personal (consumer) accounts and must be called before issuing cards or creating financial accounts for an individual. This endpoint is typically invoked by partners during customer sign-up flows or profile management workflows.

Request Body

All fields from the base profile schema are inherited. Required fields are marked accordingly.

{
  "email": "[email protected]",
  "givenName": "Jane",
  "familyName": "Doe",
  "middleName": "Marie",
  "cardProductId": "card-product-abc123",
  "agentPayoutProfileId": 101,
  "salesRepresentativeId": 55,
  "merchantProfileId": null,
  "isRisk": false,
  "nickName": "JD",
  "password": "SecurePass!2025",
  "partnerId": 12,
  "phone": "5551234567",
  "ssn": "XXX-XX-XXXX",
  "dateOfBirth": "1990-04-15T00:00:00Z",
  "streetAddress": "123 Main St",
  "extendedAddress": "Apt 4B",
  "city": "Austin",
  "postalCode": "78701",
  "state": 43,
  "employerId": null
}

Response

200 OK

{
  "error": null,
  "profileId": 98765
}

Error Codes

Common Mistakes

• Submitting ssn in a format other than a valid 9-digit US SSN — the API enforces a strict regex pattern and will reject invalid values.
• Providing an invalid state integer — the value must be a valid enum integer between 1 and 53 corresponding to a US state or territory; string abbreviations (e.g., "TX") are not accepted.
• Omitting agentPayoutProfileId or salesRepresentativeId — both are required base profile fields even though they may not be obvious from the personal profile fields alone.
• Sending dateOfBirth as a plain date string (e.g., "1990-04-15") instead of ISO 8601 date-time format (e.g., "1990-04-15T00:00:00Z").
• Using a streetAddress value that does not conform to the required US street address pattern, which will cause a 400 validation error.

Related Endpoints

• POST /api/auth/v2 — Obtain a Bearer token required to call this endpoint
• POST /api/auth/refresh — Refresh an expiring Bearer token
• POST /netevia/oma/profile/business — Create or update a business customer profile

Example

curl -X POST https://api.banking.netevia.dev/netevia/oma/profile/personal \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "givenName": "Jane",
    "familyName": "Doe",
    "middleName": "Marie",
    "cardProductId": "card-product-abc123",
    "agentPayoutProfileId": 101,
    "salesRepresentativeId": 55,
    "isRisk": false,
    "partnerId": 12,
    "phone": "5551234567",
    "ssn": "XXX-XX-XXXX",
    "dateOfBirth": "1990-04-15T00:00:00Z",
    "streetAddress": "123 Main St",
    "extendedAddress": "Apt 4B",
    "city": "Austin",
    "postalCode": "78701",
    "state": 43
  }'