> ## Documentation Index > Fetch the complete documentation index at: https://docs.lightspark.com/llms.txt > Use this file to discover all available pages before exploring further. # Create a beneficial owner > Add a beneficial owner, director, or company officer to a business customer. The beneficial owner will go through KYC verification automatically. ## OpenAPI ````yaml https://app.stainless.com/api/spec/documented/grid/openapi.documented.yml post /beneficial-owners openapi: 3.1.0 info: title: Grid API description: > API for managing global payments on the open Money Grid. Built by Lightspark. See the full documentation at https://docs.lightspark.com/. version: '2025-10-13' contact: name: Lightspark Support email: support@lightspark.com license: name: Proprietary url: https://lightspark.com/terms servers: - url: https://api.lightspark.com/grid/2025-10-13 description: Production server security: - BasicAuth: [] - AgentAuth: [] tags: - name: Platform Configuration description: >- Platform configuration endpoints for managing global settings. You can also configure these settings in the Grid dashboard. - name: Customers description: >- Customer management endpoints for creating and updating customer information - name: KYC/KYB Verifications description: >- Endpoints for Know Your Customer (KYC) and Know Your Business (KYB) verification, including managing beneficial owners and triggering verification for customers. - name: Documents description: >- Endpoints for uploading and managing verification documents for customers and beneficial owners. Supports KYC and KYB document requirements. - name: Internal Accounts description: >- Internal account management endpoints for creating and managing internal accounts - name: External Accounts description: >- External account management endpoints for creating and managing external bank accounts - name: Same-Currency Transfers description: >- Endpoints for transferring funds between internal and external accounts with the same currency - name: Cross-Currency Transfers description: Endpoints for creating and confirming quotes for cross-currency transfers - name: Transactions description: Endpoints for retrieving transaction information - name: Webhooks description: Webhook endpoints and configuration for receiving notifications - name: Invitations description: Endpoints for creating, claiming and managing UMA invitations - name: Sandbox description: Endpoints to trigger test cases in sandbox - name: API Tokens description: Endpoints to programmatically manage API tokens - name: Exchange Rates description: >- Endpoints for retrieving cached foreign exchange rates. Rates are cached for approximately 5 minutes and include platform-specific fees. - name: Discoveries description: >- Endpoints for discovering available payment rails, banks, and providers for a given country and currency corridor. - name: Embedded Wallet Auth description: >- Endpoints for registering and verifying end-user authentication credentials (email OTP, OAuth, passkey) used to sign Embedded Wallet actions. - name: Agent Management description: >- Endpoints for creating and managing agents (experimental), called by the partner's backend using platform credentials. Covers the full agent lifecycle: creation, policy configuration, pausing, deletion, the device code installation flow, and approving or rejecting transactions initiated by agents. - name: Agent Operations description: >- Endpoints called by the agent itself using its own credentials (obtained via device code redemption). Scoped to the agent's associated customer — all requests automatically operate on behalf of that customer and are subject to the agent's policy. When an action requires approval, the resulting transaction enters a pending state and must be approved by the platform via `POST /transactions/{transactionId}/approve`. - name: Cards description: >- Card management endpoints. Issue debit cards against an internal account, freeze / unfreeze, close, manage card funding sources, and list card transactions. paths: /beneficial-owners: post: tags: - KYC/KYB Verifications summary: Create a beneficial owner description: > Add a beneficial owner, director, or company officer to a business customer. The beneficial owner will go through KYC verification automatically. operationId: createBeneficialOwner requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BeneficialOwnerCreateRequest' responses: '201': description: Beneficial owner created successfully content: application/json: schema: $ref: '#/components/schemas/BeneficialOwner' '400': description: Bad request - Invalid parameters content: application/json: schema: $ref: '#/components/schemas/Error400' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '404': description: Customer not found content: application/json: schema: $ref: '#/components/schemas/Error404' '500': description: Internal service error content: application/json: schema: $ref: '#/components/schemas/Error500' security: - BasicAuth: [] x-codeSamples: - lang: JavaScript source: |- import LightsparkGrid from '@lightsparkdev/grid'; const client = new LightsparkGrid({ username: process.env['GRID_CLIENT_ID'], // This is the default and can be omitted password: process.env['GRID_CLIENT_SECRET'], // This is the default and can be omitted }); const beneficialOwner = await client.beneficialOwners.create({ customerId: 'Customer:019542f5-b3e7-1d02-0000-000000000001', ownershipPercentage: 51, personalInfo: { address: { country: 'US', line1: '123 Main Street', postalCode: '94105', }, birthDate: '1978-06-15', firstName: 'Jane', identifier: '123-45-6789', idType: 'SSN', lastName: 'Smith', nationality: 'US', }, roles: ['UBO', 'DIRECTOR'], }); console.log(beneficialOwner.id); - lang: Python source: |- import os from datetime import date from grid import LightsparkGrid client = LightsparkGrid( username=os.environ.get("GRID_CLIENT_ID"), # This is the default and can be omitted password=os.environ.get("GRID_CLIENT_SECRET"), # This is the default and can be omitted ) beneficial_owner = client.beneficial_owners.create( customer_id="Customer:019542f5-b3e7-1d02-0000-000000000001", ownership_percentage=51, personal_info={ "address": { "country": "US", "line1": "123 Main Street", "postal_code": "94105", }, "birth_date": date.fromisoformat("1978-06-15"), "first_name": "Jane", "identifier": "123-45-6789", "id_type": "SSN", "last_name": "Smith", "nationality": "US", }, roles=["UBO", "DIRECTOR"], ) print(beneficial_owner.id) - lang: Go source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"time\"\n\n\t\"github.com/stainless-sdks/grid-go\"\n\t\"github.com/stainless-sdks/grid-go/option\"\n)\n\nfunc main() {\n\tclient := grid.NewClient(\n\t\toption.WithUsername(\"My Username\"),\n\t\toption.WithPassword(\"My Password\"),\n\t)\n\tbeneficialOwner, err := client.BeneficialOwners.New(context.TODO(), grid.BeneficialOwnerNewParams{\n\t\tBeneficialOwnerCreateRequest: grid.BeneficialOwnerCreateRequestParam{\n\t\t\tCustomerID: \"Customer:019542f5-b3e7-1d02-0000-000000000001\",\n\t\t\tOwnershipPercentage: 51,\n\t\t\tPersonalInfo: grid.BeneficialOwnerPersonalInfoParam{\n\t\t\t\tAddress: grid.AddressParam{\n\t\t\t\t\tCountry: \"US\",\n\t\t\t\t\tLine1: \"123 Main Street\",\n\t\t\t\t\tPostalCode: \"94105\",\n\t\t\t\t},\n\t\t\t\tBirthDate: time.Now(),\n\t\t\t\tFirstName: \"Jane\",\n\t\t\t\tIdentifier: \"123-45-6789\",\n\t\t\t\tIDType: grid.BeneficialOwnerPersonalInfoIDTypeSsn,\n\t\t\t\tLastName: \"Smith\",\n\t\t\t\tNationality: \"US\",\n\t\t\t},\n\t\t\tRoles: []string{\"UBO\", \"DIRECTOR\"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", beneficialOwner.ID)\n}\n" - lang: Kotlin source: >- package com.lightspark.grid.example import com.lightspark.grid.client.LightsparkGridClient import com.lightspark.grid.client.okhttp.LightsparkGridOkHttpClient import com.lightspark.grid.models.BeneficialOwner import com.lightspark.grid.models.beneficialowners.BeneficialOwnerCreateRequest import com.lightspark.grid.models.beneficialowners.BeneficialOwnerPersonalInfo import com.lightspark.grid.models.customers.externalaccounts.Address import java.time.LocalDate fun main() { val client: LightsparkGridClient = LightsparkGridOkHttpClient.fromEnv() val params: BeneficialOwnerCreateRequest = BeneficialOwnerCreateRequest.builder() .customerId("Customer:019542f5-b3e7-1d02-0000-000000000001") .ownershipPercentage(51L) .personalInfo(BeneficialOwnerPersonalInfo.builder() .address(Address.builder() .country("US") .line1("123 Main Street") .postalCode("94105") .build()) .birthDate(LocalDate.parse("1978-06-15")) .firstName("Jane") .identifier("123-45-6789") .idType(BeneficialOwnerPersonalInfo.IdType.SSN) .lastName("Smith") .nationality("US") .build()) .addRole(BeneficialOwnerCreateRequest.Role.UBO) .addRole(BeneficialOwnerCreateRequest.Role.DIRECTOR) .build() val beneficialOwner: BeneficialOwner = client.beneficialOwners().create(params) } - lang: Ruby source: >- require "grid" lightspark_grid = Grid::Client.new(username: "My Username", password: "My Password") beneficial_owner = lightspark_grid.beneficial_owners.create( customer_id: "Customer:019542f5-b3e7-1d02-0000-000000000001", ownership_percentage: 51, personal_info: { address: {country: "US", line1: "123 Main Street", postalCode: "94105"}, birthDate: "1978-06-15", firstName: "Jane", identifier: "123-45-6789", idType: :SSN, lastName: "Smith", nationality: "US" }, roles: [:UBO, :DIRECTOR] ) puts(beneficial_owner) - lang: PHP source: |- beneficialOwners->create( customerID: 'Customer:019542f5-b3e7-1d02-0000-000000000001', ownershipPercentage: 51, personalInfo: [ 'address' => [ 'country' => 'US', 'line1' => '123 Main Street', 'postalCode' => '94105', 'city' => 'San Francisco', 'line2' => 'Apt 4B', 'state' => 'CA', ], 'birthDate' => '1978-06-15', 'firstName' => 'Jane', 'identifier' => '123-45-6789', 'idType' => 'SSN', 'lastName' => 'Smith', 'nationality' => 'US', 'countryOfIssuance' => 'US', 'email' => 'jane.smith@acmecorp.com', 'middleName' => 'Marie', 'phoneNumber' => '+14155550192', ], roles: ['UBO', 'DIRECTOR'], ); var_dump($beneficialOwner); } catch (APIException $e) { echo $e->getMessage(); } - lang: C# source: >- using System; using Grid; using Grid.Models.BeneficialOwners; LightsparkGridClient client = new(); BeneficialOwnerCreateParams parameters = new() { CustomerID = "Customer:019542f5-b3e7-1d02-0000-000000000001", OwnershipPercentage = 51, PersonalInfo = new() { Address = new() { Country = "US", Line1 = "123 Main Street", PostalCode = "94105", City = "San Francisco", Line2 = "Apt 4B", State = "CA", }, BirthDate = "1978-06-15", FirstName = "Jane", Identifier = "123-45-6789", IDType = BeneficialOwnerPersonalInfoIDType.Ssn, LastName = "Smith", Nationality = "US", CountryOfIssuance = "US", Email = "jane.smith@acmecorp.com", MiddleName = "Marie", PhoneNumber = "+14155550192", }, Roles = [ Role.Ubo, Role.Director ], }; var beneficialOwner = await client.BeneficialOwners.Create(parameters); Console.WriteLine(beneficialOwner); - lang: CLI source: |- grid beneficial-owners create \ --username 'My Username' \ --password 'My Password' \ --customer-id Customer:019542f5-b3e7-1d02-0000-000000000001 \ --ownership-percentage 51 \ --personal-info "{address: {country: US, line1: 123 Main Street, postalCode: '94105'}, birthDate: '1978-06-15', firstName: Jane, identifier: 123-45-6789, idType: SSN, lastName: Smith, nationality: US}" \ --role UBO \ --role DIRECTOR components: schemas: BeneficialOwnerCreateRequest: type: object required: - customerId - roles - ownershipPercentage - personalInfo properties: customerId: type: string description: >- The ID of the business customer this beneficial owner is associated with example: Customer:019542f5-b3e7-1d02-0000-000000000001 roles: type: array items: $ref: '#/components/schemas/BeneficialOwnerRole' description: Roles of this person within the business example: - UBO - DIRECTOR ownershipPercentage: type: integer description: >- Percentage of ownership in the business (0-100). Relevant when role includes UBO. minimum: 0 maximum: 100 example: 51 personalInfo: $ref: '#/components/schemas/BeneficialOwnerPersonalInfo' BeneficialOwner: type: object required: - id - customerId - roles - ownershipPercentage - personalInfo - kycStatus - createdAt properties: id: type: string description: Unique identifier for this beneficial owner example: BeneficialOwner:019542f5-b3e7-1d02-0000-000000000001 customerId: type: string description: >- The ID of the business customer this beneficial owner is associated with example: Customer:019542f5-b3e7-1d02-0000-000000000001 roles: type: array items: $ref: '#/components/schemas/BeneficialOwnerRole' description: Roles of this person within the business example: - UBO - DIRECTOR ownershipPercentage: type: integer description: Percentage of ownership in the business (0-100) minimum: 0 maximum: 100 example: 51 personalInfo: $ref: '#/components/schemas/BeneficialOwnerPersonalInfo' kycStatus: $ref: '#/components/schemas/KycStatus' createdAt: type: string format: date-time description: When this beneficial owner was created example: '2025-10-03T12:00:00Z' updatedAt: type: string format: date-time description: When this beneficial owner was last updated example: '2025-10-03T12:00:00Z' Error400: type: object required: - message - status - code properties: status: type: integer enum: - 400 description: HTTP status code code: type: string description: > | Error Code | Description | |------------|-------------| | INVALID_INPUT | Invalid input provided | | MISSING_MANDATORY_USER_INFO | Required customer information is missing | | INVITATION_ALREADY_CLAIMED | Invitation has already been claimed | | INVITATIONS_NOT_CONFIGURED | Invitations are not configured | | INVALID_UMA_ADDRESS | UMA address format is invalid | | INVITATION_CANCELLED | Invitation has been cancelled | | QUOTE_REQUEST_FAILED | An issue occurred during the quote process; this is retryable | | INVALID_PAYREQ_RESPONSE | Counterparty Payreq response was invalid | | INVALID_RECEIVER | Receiver is invalid | | PARSE_PAYREQ_RESPONSE_ERROR | Error parsing receiver PayReq response | | CERT_CHAIN_INVALID | Counterparty certificate chain is invalid | | CERT_CHAIN_EXPIRED | Counterparty certificate chain has expired | | INVALID_PUBKEY_FORMAT | Counterparty Public key format is invalid | | MISSING_REQUIRED_UMA_PARAMETERS | Counterparty required UMA parameters are missing | | SENDER_NOT_ACCEPTED | Sender is not accepted | | AMOUNT_OUT_OF_RANGE | Amount is out of range | | INVALID_CURRENCY | Currency is invalid | | INVALID_TIMESTAMP | Timestamp is invalid | | INVALID_NONCE | Nonce is invalid | | INVALID_REQUEST_FORMAT | Request format is invalid | | INVALID_BANK_ACCOUNT | Bank account is invalid | | SELF_PAYMENT | Self payment not allowed | | LOOKUP_REQUEST_FAILED | Lookup request failed | | PARSE_LNURLP_RESPONSE_ERROR | Error parsing LNURLP response | | INVALID_AMOUNT | Amount is invalid | | WEBHOOK_ENDPOINT_NOT_SET | Webhook endpoint is not set | | WEBHOOK_DELIVERY_ERROR | Webhook delivery error | | LOW_QUALITY | Document quality too low to process | | DATA_MISMATCH | Document details don't match provided information | | EXPIRED | Document has expired | | SUSPECTED_FRAUD | Document suspected of being forged or edited | | UNSUITABLE_DOCUMENT | Document type is not accepted or not supported | | INCOMPLETE | Document is missing pages or sides | | EMAIL_OTP_CREDENTIAL_ALREADY_EXISTS | An EMAIL_OTP credential is already registered on the target internal account; only one email OTP credential is supported per internal account at this time | | PASSKEY_CREDENTIAL_ALREADY_EXISTS | A PASSKEY credential with the same WebAuthn credentialId is already registered on the target internal account | enum: - INVALID_INPUT - MISSING_MANDATORY_USER_INFO - INVITATION_ALREADY_CLAIMED - INVITATIONS_NOT_CONFIGURED - INVALID_UMA_ADDRESS - INVITATION_CANCELLED - QUOTE_REQUEST_FAILED - INVALID_PAYREQ_RESPONSE - INVALID_RECEIVER - PARSE_PAYREQ_RESPONSE_ERROR - CERT_CHAIN_INVALID - CERT_CHAIN_EXPIRED - INVALID_PUBKEY_FORMAT - MISSING_REQUIRED_UMA_PARAMETERS - SENDER_NOT_ACCEPTED - AMOUNT_OUT_OF_RANGE - INVALID_CURRENCY - INVALID_TIMESTAMP - INVALID_NONCE - INVALID_REQUEST_FORMAT - INVALID_BANK_ACCOUNT - SELF_PAYMENT - LOOKUP_REQUEST_FAILED - PARSE_LNURLP_RESPONSE_ERROR - INVALID_AMOUNT - WEBHOOK_ENDPOINT_NOT_SET - WEBHOOK_DELIVERY_ERROR - LOW_QUALITY - DATA_MISMATCH - EXPIRED - SUSPECTED_FRAUD - UNSUITABLE_DOCUMENT - INCOMPLETE - EMAIL_OTP_CREDENTIAL_ALREADY_EXISTS - PASSKEY_CREDENTIAL_ALREADY_EXISTS message: type: string description: Error message details: type: object description: Additional error details additionalProperties: true Error401: type: object required: - message - status - code properties: status: type: integer enum: - 401 description: HTTP status code code: type: string description: > | Error Code | Description | |------------|-------------| | UNAUTHORIZED | Issue with API credentials | | INVALID_SIGNATURE | Signature header is invalid | | WALLET_SIGNATURE_MISSING | The `Grid-Wallet-Signature` header is required for this Embedded Wallet action but was not supplied | | WALLET_SIGNATURE_MALFORMED | The `Grid-Wallet-Signature` header could not be parsed (bad encoding, structure, or fields) | | WALLET_SIGNATURE_BODY_MISMATCH | The `Grid-Wallet-Signature` was computed over a different request body than the one received | | WALLET_SIGNATURE_INVALID | The `Grid-Wallet-Signature` failed cryptographic verification against the registered credential | | REQUEST_ID_MISSING | The `Request-Id` header is required on the signed retry but was not supplied (paired with `Grid-Wallet-Signature`) | enum: - UNAUTHORIZED - INVALID_SIGNATURE - WALLET_SIGNATURE_MISSING - WALLET_SIGNATURE_MALFORMED - WALLET_SIGNATURE_BODY_MISMATCH - WALLET_SIGNATURE_INVALID - REQUEST_ID_MISSING message: type: string description: Error message details: type: object description: Additional error details additionalProperties: true Error404: type: object required: - message - status - code properties: status: type: integer enum: - 404 description: HTTP status code code: type: string description: > | Error Code | Description | |------------|-------------| | TRANSACTION_NOT_FOUND | Transaction not found | | INVITATION_NOT_FOUND | Invitation not found | | USER_NOT_FOUND | Customer not found | | QUOTE_NOT_FOUND | Quote not found | | LOOKUP_REQUEST_NOT_FOUND | Lookup request not found | | TOKEN_NOT_FOUND | Token not found | | BULK_UPLOAD_JOB_NOT_FOUND | Bulk upload job not found | | REFERENCE_NOT_FOUND | Reference not found | | UMA_NOT_FOUND | The UMA address is well-formed but no receiver exists at the counterparty VASP | enum: - TRANSACTION_NOT_FOUND - INVITATION_NOT_FOUND - USER_NOT_FOUND - QUOTE_NOT_FOUND - LOOKUP_REQUEST_NOT_FOUND - TOKEN_NOT_FOUND - BULK_UPLOAD_JOB_NOT_FOUND - REFERENCE_NOT_FOUND - UMA_NOT_FOUND message: type: string description: Error message details: type: object description: Additional error details additionalProperties: true Error500: type: object required: - message - status - code properties: status: type: integer enum: - 500 description: HTTP status code code: type: string description: | | Error Code | Description | |------------|-------------| | GRID_SWITCH_ERROR | Grid switch error | | INTERNAL_ERROR | Internal server or UMA error | enum: - GRID_SWITCH_ERROR - INTERNAL_ERROR message: type: string description: Error message details: type: object description: Additional error details additionalProperties: true BeneficialOwnerRole: type: string enum: - UBO - DIRECTOR - COMPANY_OFFICER - CONTROL_PERSON - TRUSTEE - GENERAL_PARTNER description: Role of the beneficial owner within the business example: UBO BeneficialOwnerPersonalInfo: type: object required: - firstName - lastName - birthDate - nationality - address - idType - identifier properties: firstName: type: string description: First name of the individual example: Jane middleName: type: string description: Middle name of the individual example: Marie lastName: type: string description: Last name of the individual example: Smith birthDate: type: string format: date description: Date of birth in ISO 8601 format (YYYY-MM-DD) example: '1978-06-15' nationality: type: string description: Country of nationality (ISO 3166-1 alpha-2) example: US email: type: string format: email description: Email address of the individual example: jane.smith@acmecorp.com phoneNumber: type: string description: Phone number in E.164 format example: '+14155550192' pattern: ^\+[1-9]\d{1,14}$ address: $ref: '#/components/schemas/Address' idType: $ref: '#/components/schemas/IdentificationType' identifier: type: string description: The identification number or value example: 123-45-6789 countryOfIssuance: type: string description: Country that issued the identification (ISO 3166-1 alpha-2) example: US KycStatus: type: string enum: - UNVERIFIED - PENDING - APPROVED - REJECTED description: The current KYC status of a customer example: APPROVED Address: type: object required: - line1 - postalCode - country properties: line1: type: string description: Street address line 1 example: 123 Main Street line2: type: string description: Street address line 2 example: Apt 4B city: type: string description: City example: San Francisco state: type: string description: State/Province/Region example: CA postalCode: type: string description: Postal/ZIP code example: '94105' country: type: string description: Country code (ISO 3166-1 alpha-2) example: US IdentificationType: type: string enum: - SSN - ITIN - EIN - NON_US_TAX_ID description: Type of tax identification example: SSN securitySchemes: BasicAuth: type: http scheme: basic description: >- API token authentication using format `:` AgentAuth: type: http scheme: bearer description: >- Bearer token authentication for agent-scoped endpoints. The token is the `accessToken` returned when redeeming a device code via `POST /agents/device-codes/{code}/redeem`. Agent credentials are user-scoped: all requests are automatically bound to the agent's associated customer and subject to the agent's policy. ````