cs-security-experience-api-services
This API provides identity validation, OTP management, survey generation, token handling for portals, and blacklist verification across multiple versions to ensure secure authentication and data processing
home
π Home - π‘οΈcs-security-experience-api-services
This API offers robust identity and security validation services. It includes endpoints for:
- Identity and phone verification
- One-Time Password (OTP) operations
- Security surveys and token management
- Integration with Experian, Inspektor, Fasecolda, RegistradurΓa, Ariba, TransUnion
- Evaluation of restrictive lists and authentication assessments
All services are exposed through organized versions (v1
, v3
, v4
) and provide secure access to backend validations.
π Base Information
- API Title: cs-security-experience-api-services
- Version: 1.0.0
- Base URL:
https://security-experience-api-prod.us-e1.cloudhub.io/api
π Getting Started
- Authentication: Ensure you have the required
client_id
andOAuth 2.0
Bearer token for secure access. - Base URL: Use the provided Base URL as the prefix for all API endpoints.
- Headers: Add the following headers in your API requests:-H "client_id: YOUR_CLIENT_ID" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
π How to Consume
You can access and consume this API through the following platforms:
π Available Endpoints
π Endpoints Overview
Method | Endpoint | Description | Exchange Link |
---|---|---|---|
POST | /customer/v1/identity/validate | Validates customer identity. | View details |
POST | /security/v1/OTP/initialize | Sends OTP to customer's device. | View details |
POST | /security/v1/OTP/validate | Validates customer's OTP input. | View details |
POST | /security/v1/survey/generate | Creates a security survey for customer. | View details |
POST | /security/v1/survey/validate | Validates customer's survey responses. | View details |
POST | /security/v1/portal/generate_token | Generates token for portal login. | View details |
POST | /security/v1/portal/validate_token | Validates token for portal login. | View details |
POST | /security/check_bls | Checks customer against restrictive lists (BLS). | View details |
π Version v3 - Experian & Inspektor Integration
Method | Endpoint | Description | Exchange Link |
---|---|---|---|
POST | /v3/customer/identity/validate | Identity validation with Experian. | View details |
POST | /v3/security/OTP/initialize | Sends OTP using Experian service. | View details |
POST | /v3/security/OTP/validate | Validates OTP via Experian. | View details |
POST | /v3/security/survey/generate | Generates security survey using Experian. | View details |
POST | /v3/security/survey/validate | Validates survey via Experian. | View details |
POST | /v3/security/portal/generate_token | Generates token (v3 version). | View details |
POST | /v3/security/portal/validate_token | Validates token (v3 version). | View details |
POST | /v3/security/check_bls | Restrictive list check via Inspektor. | View details |
POST | /v3/security/restrictiveList/inspektor | Queries Inspektor restrictive lists. | View details |
POST | /v3/security/authentication/business | Authenticates business users. | View details |
POST | /v3/security/authentication/supplier | Authenticates suppliers. | View details |
π Version v4 - Token Management
Method | Endpoint | Description | Exchange Link |
---|---|---|---|
POST | /v4/customer/identity/portal/generate_token | Generates identity portal token. | View details |
POST | /v4/customer/identity/portal/validate_token | Validates identity portal token. | View details |
π Third-party Integrations
Method | Endpoint | Description | Exchange Link |
---|---|---|---|
GET | /data-credito/HC2 | Queries Experian + RegistradurΓa. | View details |
GET | /fasecolda/obtainUrl | Retrieves Fasecolda auth URL. | View details |
GET | /ariba/obtainPendingSuppliers | Gets pending Ariba suppliers. | View details |
POST | /assessment-files | Sends authentication assessment files. | View details |
π Files & TransUnion Services
Method | Endpoint | Description | Exchange Link |
---|---|---|---|
POST | /identity-and-phone-verification | Verifies identity and phone via TransUnion. | View details |
POST | /otp-phone-selection | Selects phone number for TransUnion OTP. | View details |
POST | /otp-pin-verification-otp-input | Verifies entered OTP PIN (TransUnion). | View details |
POST | /obtaining-and-responding-exam | Executes and responds to TransUnion security exam. | View details |
POST | /identity-validation-status | Save states of the IVR in Salesforce. | View details |
π€ Example Request (Generic)
curl -X POST "<endpoint>" \
-H "Content-Type: application/json" \
-d '{ "key": "value" }'
Replace <endpoint>
and the payload based on the specific method.
β οΈ Error Handling
Standard HTTP status codes are used for error handling:
200 OK
β Request was successful400 Bad Request
β Missing or invalid parameters401 Unauthorized
β Authentication failed404 Not Found
β Endpoint or resource not found500 Internal Server Error
β Unexpected error on the server
π Support
For any issues, please contact the API support team:
Integration Services and Applications Coordination
π§ epalma@fgs.co
π Notes
- Documentation last updated: June 2025
- For further updates, refer to the API Exchange Portal