Onboarding API
Onboarding API
Base URLs
Environment | URL |
|---|---|
Sandbox Environment. Interfaces with sandbox data |
|
Production Environment. Interfaces with live Data |
|
Endpoints
/{program_code}/v1/oauth/consumer/kyc/providers
/{program_code}/v1/users/authentications/documents/process
/{program_code}/v1/users/authentications/statuses
/{program_code}/v1/users/authentications/documents
/{program_code}/v1/users/authentications/documents
/{program_code}/v1/users/authentications/documents
/{program_code}/v1/users/authentications/documents/{document_id}
/{program_code}/v1/businesses/status
/{program_code}/v1/businesses
/{program_code}/v1/businesses
/{program_code}/v1/businesses
/{program_code}/v1/{business_id}/businesses
/{program_code}/v1/{business_id}/users
/{program_code}/v1/users
/{program_code}/v1/users
/{program_code}/v1/users
/{program_code}/v1/users/{user_id}
/{program_code}/v1/users/{user_id}
/{program_code}/v1/users/status
/{program_code}/v1/users/addresses/{type}
/{program_code}/v1/users/addresses/{type}
/{program_code}/v1/users/addresses
/{program_code}/v1/businesses/authentications/documents
/{program_code}/v1/businesses/authentications/documents
/{program_code}/v1/businesses/authentications/documents
/{program_code}/v1/businesses/authentications/documents/{document_id}
/{program_code}/v1/businesses/authentications/statuses
/{program_code}/v1/businesses/addresses/{type}
/{program_code}/v1/businesses/addresses/{type}
/{program_code}/v1/businesses/addresses
/{program_code}/v1/users/enumerations/{group}
/{program_code}/v1/users/enumerations/transfers/purpose
/{program_code}/v2/users/statuses/{user_id}
/{program_code}/v2/users?client_ref_id=&email=&mobile=&page=&records_per_page=
{program_code}/v2/users
/{program_code}/v2/users/{user_id}
/{program_code}/v2/users/{user_id}
/{program_code}/v2/users/authentications/documents?page=&records_per_page=
/{program_code}/v2/users/authentications/documents
/{program_code}/v2/users/authentications/documents/{document_id}
/{program_code}/v2/users/authentications/documents/process
{program_code}/v2/users/authentications/documents/verifications
/{program_code}/v2/users/authentications/documents/verification_modes
/{program_code}/v2/businesses/statuses/{business_id}
/{program_code}/v2/businesses
/{program_code}/v2/businesses
/{program_code}/v2/businesses
/{program_code}/v2/businesses/{business_id}/users
/{program_code}/v2/businesses/{business_id}/businesses
/{program_code}/v2/users/enumerations/genders
/{program_code}/v2/users/enumerations/file_types
/{program_code}/v2/users/enumerations/mobile_country_codes
/{program_code}/v2/users/enumerations/status_reason_codes
/{program_code}/v2/users/enumerations/annual_income_range
/{program_code}/v2/users/enumerations/countries
/{program_code}/v2/users/enumerations/document_substatuses
/{program_code}/v2/users/enumerations/document_types
/{program_code}/v2/users/enumerations/employment_type
/{program_code}/v2/users/enumerations/id_issuance_countries
/{program_code}/v2/users/enumerations/id_types
/{program_code}/v2/users/enumerations/job_title
/{program_code}/v2/users/enumerations/main_income_source
/{program_code}/v2/users/enumerations/marital_status
/{program_code}/v2/users/enumerations/nationalities
/{program_code}/v2/users/enumerations/supporting_documents_id_types
/{program_code}/v2/users/enumerations/titles
/{program_code}/v2/users/enumerations/industries
/{program_code}/v2/users/enumerations/residency_status
/{program_code}/v2/businesses/authentications/documents/process
/{program_code}/v2/businesses/authentications/documents/verifications
/{program_code}/v2/businesses/authentications/documents?page=&records_per_page=
/{program_code}/v2/businesses/authentications/documents/verification_modes
/{program_code}/v2/associated_parties/{associated_party_id}/authentications/documents/proc...
/{program_code}/v2/associated_parties/{associated_party_id}/authentications/documents/veri...
/{program_code}/v2/associated-parties/{associated_party_id}/documents/verification_modes
/{program_code}/v2/associated_parties/{associated_party_id}
/{program_code}/v2/associated_parties?email=&mobile=&parent_id=&hash_id=&type=&status=&kyc...
/{program_code}/v2/users/enumerations/business_associated_parties_roles
/{program_code}/v2/users/enumerations/business_document_substatuses
/{program_code}/v2/users/enumerations/business_document_types
/{program_code}/v2/users/enumerations/business_id_issuance_countries
/{program_code}/v2/users/enumerations/business_id_types
/{program_code}/v2/users/enumerations/business_purpose_of_account
/{program_code}/v2/users/enumerations/business_roles
/{program_code}/v2/users/enumerations/business_source_of_funds
/{program_code}/v2/users/enumerations/business_supporting_documents_id_types
/{program_code}/v2/users/enumerations/business_company_types
/{program_code}/v2/users/statuses/{user_id}
/{program_code}/v2/users?client_ref_id=&email=&mobile=&page=&records_per_page=
/{program_code}/v2/users
/{program_code}/v2/users/{user_id}
/{program_code}/v2/users/{user_id}
/{program_code}/v2/users/resend/otp
/{program_code}/v2/users/verify
/{program_code}/v2/users/verify/otp
/{program_code}/v2/users/verify/otp
/{program_code}/v2/users/trigger/otp/{type}
/{program_code}/v2/users/authentications/documents/verifications
/{program_code}/v2/users/authentications/documents
/{program_code}/v2/users/authentications/documents
/{program_code}/v2/users/authentications/documents
/{program_code}/v2/users/authentications/documents/{document_id}
/{program_code}/v2/users/enumerations/{group}
/{program_code}/v2/simulate/users/authentications/documents/status
identity-kyc-verification-started
identity-kyc-verification-completed
identity-kyc-verification-approved
identity-kyc-verification-failed
identity-kyc-verification-rejected
identity-kyc-verification-approved-v2-ph-deprecated
identity-kyc-verification-failed-v2-ph-deprecated
identity-kyc-verification-rejected-v2-ph-deprecated
identity-user-information-update
identity-user-verification-status
identity-user-verification-status-sg-deprecated
identity-user-status
identity-user-profile-update
identity-associated-party-verification-status-deprecated
identity-associated-party-status
identity-associated-party-update