Create main business profile data

Create Main Business Profile

The POST /netevia/profile endpoint creates a primary business profile within the Netevia banking platform. This profile serves as the foundational account for all future transactions and financial activities. Upon successful creation, a unique profile ID is returned for use in subsequent operations.

Endpoint

POST /netevia/profile

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 business customer to the Netevia platform. It must be called before any other business-specific operations such as creating financial accounts, issuing cards, or managing authorized users (subProfiles). The returned profileId is required for all subsequent boarding and account management requests.

Request Body

FieldTypeRequiredDescription
emailstring (email)YesPrimary contact email address for the business profile
givenNamestringYesFirst name of the primary account holder
familyNamestringYesLast name of the primary account holder
middleNamestringNoMiddle name of the primary account holder
agentPayoutProfileIdinteger (int32)YesID of the agent payout profile associated with this account
salesRepresentativeIdinteger (int32)YesID of the sales representative responsible for this account
cardProductIdstringNoCard product identifier to associate with the profile
merchantProfileIdinteger (int32)NoOptional merchant profile ID to link to this business
isRiskbooleanNoFlag indicating whether the account is flagged for risk review
nickNamestringNoOptional display name for the profile
passwordstringNoInitial password for the business account
partnerIdinteger (int32)NoPartner identifier for multi-partner deployments
legalBusinessNamestringNoOfficial registered legal name of the business
doingBusinessAsNamestringNoTrade name or DBA name of the business
{
  "email": "[email protected]",
  "givenName": "Jane",
  "familyName": "Smith",
  "middleName": "A",
  "agentPayoutProfileId": 101,
  "salesRepresentativeId": 55,
  "cardProductId": "CARD-PROD-001",
  "merchantProfileId": 202,
  "isRisk": false,
  "nickName": "Acme Main",
  "password": "S3cur3P@ssw0rd!",
  "partnerId": 10,
  "legalBusinessName": "Acme Corporation LLC",
  "doingBusinessAsName": "Acme Corp"
}

Response

200 OK

FieldTypeDescription
profileIdinteger (int32)Unique identifier for the newly created business profile
errorstring | nullError message if the request partially failed; null on full success
{
  "profileId": 78432,
  "error": null
}

Error Codes

CodeWhen it happens
400Missing required fields (email, givenName, familyName, agentPayoutProfileId, or salesRepresentativeId) or validation error (e.g., invalid email format)
401Token missing, expired, or invalid
403Insufficient permissions to create a business profile under the specified partner or agent
404Referenced agentPayoutProfileId, salesRepresentativeId, or merchantProfileId not found
500Internal server error

Common Mistakes

  • Omitting agentPayoutProfileId or salesRepresentativeId — both are required even though they may appear optional in some client libraries; the request will fail with a 400 error.
  • Providing an invalid email format for the email field — the field enforces format: email validation and will reject malformed addresses.
  • Reusing the same email address for multiple business profiles — each profile requires a unique email.
  • Storing the profileId only in memory — always persist the returned profileId immediately, as it is required for all subsequent boarding, account creation, and management calls.

Related Endpoints

  • POST /netevia/personal/profile — Create a primary personal (consumer) profile
  • POST /netevia/subprofile — Create an authorized user (subProfile) under an existing business profile
  • GET /netevia/profile/{profileId} — Retrieve details of an existing business profile
  • PUT /netevia/profile/{profileId} — Update an existing business profile
  • POST /netevia/account — Create a financial account linked to a business profile

Example

curl -X POST https://api.banking.netevia.dev/netevia/profile \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "givenName": "Jane",
    "familyName": "Smith",
    "agentPayoutProfileId": 101,
    "salesRepresentativeId": 55,
    "partnerId": 10,
    "legalBusinessName": "Acme Corporation LLC",
    "doingBusinessAsName": "Acme Corp"
  }'
Body Params
string | null
string | null
string
required
length ≥ 1
string
required
length ≥ 1
string
required
length ≥ 1
string | null
string | null
int32
required
int32
required
int32 | null
string | null
boolean | null
string | null
string | null
int32 | null
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json