Skip to main content
POST
/
api
/
v1
/
partners
/
{partnerId}
/
production-access-request
Request production access
curl --request POST \
  --url https://dev-api-partner.onecluster.co/api/v1/partners/{partnerId}/production-access-request \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: multipart/form-data' \
  --form apiProducts=Accounts \
  --form 'justification=<string>' \
  --form 'productionIpAddresses=<string>' \
  --form 'callbackUrls=<string>' \
  --form vpnConnectionForm='@example-file'
{
  "success": true,
  "responseCode": "00",
  "message": "Request processed successfully",
  "data": {
    "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "PENDING",
    "apiProducts": [
      "<string>"
    ],
    "requestedAt": "2023-11-07T05:31:56Z",
    "reviewedAt": "2023-11-07T05:31:56Z",
    "slaDeadline": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Your API key, formatted as: ApiKey ubn_sb_your_key_here

  • Sandbox keys start with ubn_sb_
  • Production keys start with ubn_pk_
  • Never use production keys during testing — they will charge real money

Headers

​
X-Correlation-ID
string<uuid>

Path Parameters

​
partnerId
string<uuid>
required

Body

multipart/form-data
​
apiProducts
enum<string>[]
required

Which products you want to use in production

Minimum array length: 1
Available options:
Accounts,
Payments,
Collections,
KYC
​
justification
string
required

Explain your use case and why you need production access

Minimum string length: 50
​
productionIpAddresses
string[]
required

IP addresses your servers will call from (we add these to our allowlist)

​
callbackUrls
string<uri>[]
required

Your webhook endpoints (must be HTTPS)

​
vpnConnectionForm
file

Completed VPN Connection Form PDF (provided by your UBN relationship manager)

Response

Request received — our team will review within 2-5 business days

Standard response wrapper for all successful API calls

​
success
boolean
required

Always true for successful responses

Example:

true

​
responseCode
string
required

00 means success

Example:

"00"

​
message
string
required

Human-readable description of the result

Example:

"Request processed successfully"

​
data
object
required

The actual response data (varies by endpoint)