- Documentation
- API Endpoints
- Vortex Widget
- Quotes
- Ramp
- Reference Data
- Public Key
- Webhooks
- Account Management
- Create user or retry KYCPOST
- Get user's KYC statusGET
- Get selfie liveness URLGET
- Get KYC document upload URLsPOST
- Get user informationGET
- Get user's remaining transaction limitsGET
- Submit KYC level 1 dataPOST
- Validate Pix keyGET
- Create user or retry KYCPOST
- Get user's KYC statusGET
- Get selfie liveness URLGET
- Get KYC document upload URLsPOST
- Get user informationGET
- Get user's remaining transaction limitsGET
- Submit KYC level 1 dataPOST
- Validate PIX keyGET
- List fiat accountsGET
- Create a fiat accountPOST
- Delete a fiat accountDELETE
- Get user ramp limitsPOST
- Get sanitized ramp eligibilityGET
- Create user or retry KYC
- Authentication
- KYC and KYB
- Get KYB attempt status
- Create KYB document
- Get KYB document
- Submit API-driven KYB
- Start hosted KYB
- Create KYB UBO
- Import an individual KYC token
- Record an initial KYC attempt
- Get customer status
- Create a business customer
- Create an individual customer
- Find KYB submission details
- Get a KYB redirect link
- Get a KYC redirect link
- Get KYC or KYB status
- Mark a redirect finished
- Mark a redirect opened
- Retry KYC or KYB
- Send a KYB submission
- Send a KYC submission
- Upload a KYB file
- Submit KYB information
- Upload a related-person KYB file
- Upload a KYC file
- Submit KYC information
- Select active customer entity
- Discover KYC or KYB requirements
- Get aggregate onboarding status
- Managed Profiles
- Schemas
- AccountMeta
- AveniaDocumentType
- ApiCredential
- AveniaKYCDataUploadRequest
- ApiCredentialErrorResponse
- AveniaKYCDataUploadResponse
- ApiCredentialManagedSelectorErrorResponse
- BrlaAddress
- ApiValidationErrorResponse
- BrlaErrorResponse
- BrAddress
- BrlaGetSelfieLivenessUrlResponse
- BrDocumentType
- BrlaValidatePixKeyResponse
- BrErrorResponse
- CleanupPhase
- BrGetSelfieLivenessUrlResponse
- CountryCode
- BrImportKycTokenErrorResponse
- CreateBestQuoteRequest
- BrImportKycTokenRequest
- CreateQuoteRequest
- BrImportKycTokenResponse
- BrKYCDataUploadRequest
- BrKYCDataUploadResponse
- DestinationType
- BrKybAttemptStatusResponse
- DocumentUploadEntry
- BrKybDocumentRequest
- ErrorResponse
- BrKybDocumentResponse
- FiatToken
- BrKybDocumentUploadResponse
- BrKybHostedResponse
- GetRampErrorLogsResponse
- BrKybLevel1Payload
- GetRampHistoryResponse
- BrManagedBadRequestResponse
- BrUboControlRole
- BrUboPayload
- BrUboResponse
- GetWidgetUrlLocked
- BrValidatePixKeyResponse
- GetWidgetUrlRefresh
- KYCDataUploadFileFiles
- KYCDocType
- CreateApiCredentialRequest
- KycLevel1Payload
- CreateApiCredentialResponse
- KycLevel1Response
- ListUserApiKeysResponse
- CreateManagedProfileRequest
- Networks
- CreateSubaccountRequest
- OnChainToken
- CreateSubaccountResponse
- PaymentData
- PaymentMethod
- PresignedTx
- QuoteResponse
- DomesticAddFiatAccountRequest
- RampCurrency
- DomesticCountry
- RampDirection
- DomesticCountryAndCustomerTypeRequest
- RampErrorLog
- DomesticCountryRequest
- RampPhase
- DomesticCreateCustomerRequest
- RampProcess
- DomesticCreateCustomerResponse
- RegisterRampRequest
- DomesticCreateFiatAccountResponse
- SimpleStatus
- DomesticCustomerType
- StartKYC2Request
- DomesticErrorResponse
- StartKYC2Response
- DomesticFiatAccount
- StartRampRequest
- DomesticFiatAccountType
- TaxIdType
- DomesticKybBusinessSummary
- TriggerOfframpRequest
- DomesticKybDetailsResponse
- TriggerOfframpResponse
- DomesticKybFileUploadRequest
- UnsignedTx
- DomesticKybRelatedPerson
- DomesticKybRelatedPersonFileUploadRequest
- UserApiKeyErrorResponse
- DomesticKycFileUploadRequest
- UserApiKeyPairResponse
- DomesticKycStatusResponse
- ValidatePixKeyResponse
- DomesticManagedBadRequestResponse
- DomesticRedirectLinkResponse
- DomesticRedirectNotificationRequest
- DomesticRelatedPersonFileUploadRequest
- DomesticRetryRequest
- DomesticRetryResponse
- DomesticSendSubmissionRequest
- DomesticStatus
- DomesticStatusResponse
- DomesticSubmissionResponse
- DomesticSubmitKybInformationRequest
- DomesticSubmitKycInformationRequest
- DomesticSuccessResponse
- DomesticValidationBadRequestResponse
- ErrorManagedSelectorResponse
- FlatErrorResponse
- FlatManagedSelectorErrorResponse
- GetKycStatusResponse
- GetRampHistoryTransaction
- GetUserLimitsRequest
- GetUserLimitsResponse
- GetUserRemainingLimitResponse
- GetUserResponse
- KybAttemptStatusResponse
- KybLevel1Response
- ListApiCredentialsResponse
- ListManagedProfilesResponse
- MalformedJsonErrorResponse
- ManagedProfile
- ManagedProfileErrorResponse
- ManagedProfilePagination
- ManagedProfileResponse
- ManagedSelectorErrorResponse
- OnboardingApiErrorResponse
- OnboardingDocumentRequirement
- OnboardingRequirementStep
- OnboardingRequirementsErrorResponse
- OnboardingRequirementsResponse
- OnboardingStatusErrorResponse
- OnboardingStatusResponse
- PayloadTooLargeErrorResponse
- RampInfoResponse
- RecordInitialKycAttemptRequest
- SelectActiveCustomerEntityRequest
- SelectActiveCustomerEntityResponse
- SubmitInformationResponse
- SubmitKybInformationRequest
- SubmitKycInformationRequest
- SuccessResponse
- UpdateRampRequest
- UserLimit
- UserLimitPeriod
Get user's KYC status
Production
Production
GET
/v1/brl/getKycStatus
X-API-Key or Supabase Bearer session.Request
Authorization
API Key
Add parameter in header
X-API-Key
Example:
X-API-Key: ********************or
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************or
Query Params
Header Params
Responses
🟢200
application/json
Bodyapplication/json
🟠400
🟠404
🟠409
🔴500
🔴502
🟠401ManagedSelectorUnauthorized
🟠403BrlaManagedSelectorForbidden
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/v1/brl/getKycStatus?taxId=' \
--header 'X-Managed-Profile-Id;' \
--header 'X-API-Key: <api-key>'Response Response Example
200 - Example 1
{
"failureReason": "face",
"level": "string",
"result": "APPROVED",
"status": "PENDING",
"type": "KYC"
}Modified at 2026-08-19 18:12:56