parallel api.swagger 18c8e8b4696a4a9baa793e70ce795c07.yml
Parallel Markets API
Description
The Parallel Markets API allows users to assert their identity and accreditation status on other websites.
Terms of Service
Parallel Markets Terms of Service
External Documentation
Parallel Markets Developer Documentation
Servers
- Production Environment:
https://api.parallelmarkets.com/v1 - Sandbox Environment:
https://demo-api.parallelmarkets.com/v1
Tags
- Profile: Access basic user or business profile information
More Info - Accreditation: Access user or business accreditation history
More Info - Identity: Access user or business KYC/AML data and validation results
More Info
API Paths
Get Profile Information
- Endpoint:
/me
Method: GET
Tags: Profile
Summary: Get profile information
Responses:200: Information found401: Invalid authentication token provided
Get Profile Information for a Given Entity
- Endpoint:
/profile/{id}
Method: GET
Parameters:id(path) - A unique identifier for the subject
Tags: Profile
Summary: Get profile information for the given entity
Responses:200: Information found401: Invalid authentication token provided
Get Accreditation History
- Endpoint:
/accreditations
Method: GET
Tags: Accreditation
Summary: Get accreditation history
Responses:200: Information found401: Invalid authentication token provided
Get Accreditation History for a Given Entity
- Endpoint:
/accreditations/{id}
Method: GET
Parameters:id(path) - A unique identifier for the subject
Tags: Accreditation
Summary: Get accreditation history for the given entity
Responses:200: Information found401: Invalid authentication token provided
Get KYC/AML Information
- Endpoint:
/identity
Method: GET
Tags: Identity
Summary: Get KYC/AML information and validation results for the authenticated entity
Responses:200: Information found401: Invalid authentication token provided
Get KYC/AML Information for a Dependency
- Endpoint:
/identity/{dependency_id}
Method: GET
Parameters:dependency_id(path) - A unique identifier for the dependency
Tags: Identity
Summary: Get KYC/AML information and validation results for a dependency of the authenticated entity
Responses:200: Information found401: Invalid authentication token provided
Get Specific Case Management Records for Businesses
- Endpoint:
/partner-records/businesses
Method: GET
Tags: Case Management
Summary: Get a list of case management records for businesses
Responses:200: Information found401: Invalid authentication token provided
Get Specific Case Management Records for Individuals
- Endpoint:
/partner-records/individuals
Method: GET
Tags: Case Management
Summary: Get a list of case management records for individuals
Responses:200: Information found401: Invalid authentication token provided
Get a Specific Case Management Record
- Endpoint:
/partner-records/{id}
Method: GET
Parameters:id(path) - A unique identifier for the record
Tags: Case Management
Summary: Get a specific case management record
Responses:200: Information found401: Invalid authentication token provided
Additional Endpoints
The API also includes a variety of other endpoints for obtaining detailed records, changes, statuses, risk matches, and files associated with the individual and businesses.