Register a business customer with the connector's provider

Same contract as the individual registration, with business (KYB) fields; registrationCountry is required.

PUT /customers/{customerId}/connectors/{connectorId}/register/business

Register a business customer with the connector's provider

cURL

curl --request PUT \
  --url https://api.zeam.money/gw/v1/customers/{customerId}/connectors/{connectorId}/register/business \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-zeam-auth: <api-key>' \
  --data '
{
  "returnUrl": "<string>",
  "registrationCountry": "<string>"
}
'

200

{
  "customerId": "<string>",
  "status": "Pending",
  "hostedUrl": "<string>"
}

Authorizations

Authorization · string · header · required

Access token issued by POST /v1/auth/token.

x-zeam-auth · string · header · required

Application secret (the apiKey issued at registration), required on every request.

Path Parameters

customerId · string · required

connectorId · string<uuid> · required

Connector identifier.

Body

application/json

The provider's business (KYB) prefill fields. returnUrl and registrationCountry are required; everything else is optional and passed to the provider as given.

returnUrl · string<uri> · required

Absolute https URL the provider sends the customer back to.

Pattern: ^https://

registrationCountry · string · required

ISO 3166-1 alpha-2 country of registration.

Required string length: 2

Response

200

application/json

Pending with a hostedUrl (send the customer there), ActionRequired with a hostedUrl, or Rejected.

customerId · string

status · enum<string>

Available options: Pending, Verified, Rejected, ActionRequired

hostedUrl · string<uri>

Present with Pending (200) and ActionRequired: send the customer here to complete onboarding.