Register an individual customer with the connector's provider

customerId is your own id for the customer, unique within your association. Registering the same customer again returns its current status. Follow hostedUrl, when present, to finish onboarding.

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

Register an individual customer with the connector's provider

cURL

curl --request PUT \
  --url https://api.zeam.money/gw/v1/customers/{customerId}/connectors/{connectorId}/register/individual \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-zeam-auth: <api-key>' \
  --data '
{
  "returnUrl": "<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 individual (KYC) prefill fields. Only returnUrl is 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://

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.