Get Partner Profile

get/api/partner-profiles/{accountId}

Retrieve the partner profile information for a specific account.

Request

Path Parameters

accountIdstringrequired
Account id for the partner profile

Response

Successful operation.

Body application/json

accountIdstringrequired
The unique identifier of the partner account
createdAtstring<date-time>required
ISO 8601 timestamp when the partner profile was created
modifiedAtstring<date-time>required
ISO 8601 timestamp when the partner profile was last modified
isKycStatementsSubmissionAllowedbooleanrequired
Whether KYC statements submission is allowed for this partner
logoUrlstring | null
URL to the partner's logo image
supportEmailstring | null
Support email address for the partner
email.kyc.enabledboolean | null
Whether KYC email notifications are enabled for this partner
email.kycConfirmation.cardActivation.urlstring | null
URL for the card activation banner in KYC confirmation emails
email.kycConfirmation.successBanner.urlstring | null
URL for the success banner in KYC confirmation emails
email.xpayConfirmation.applePayBanner.urlstring | null
URL for the Apple Pay banner in xPay confirmation emails
email.xpayConfirmation.googlePayBanner.urlstring | null
URL for the Google Pay banner in xPay confirmation emails
supportUrlstring | null
URL to the partner's support page

No Authorization to access resource.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
reasonstring

Example

Example Request

ServerAuthentication

curl 'https://api.immersve.com/api/partner-profiles/{accountId}' \
  --header 'Authorization: Bearer <access-token>'

Example Response

{
  "accountId": "225d85e65495722bf6517ea0ba0d6f56",
  "createdAt": "2023-10-14T10:30:00.000Z",
  "modifiedAt": "2023-10-14T15:45:30.000Z",
  "isKycStatementsSubmissionAllowed": true,
  "logoUrl": "https://example.com/logo.png",
  "supportEmail": "support@partner.com",
  "email.kyc.enabled": true,
  "email.kycConfirmation.cardActivation.url": "https://example.com/kyc-card-activation.png",
  "email.kycConfirmation.successBanner.url": "https://example.com/kyc-success.png",
  "email.xpayConfirmation.applePayBanner.url": "https://example.com/apple-pay.png",
  "email.xpayConfirmation.googlePayBanner.url": "https://example.com/google-pay.png",
  "supportUrl": "https://partner.com/support"
}

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}