Consumer-Credit-Scoring

/Consumer-Credit-Scoring
POST

Calculate FICO Score

/credit-risk/consumer-scoring/fico/calculate
/1.1.1Consumer-Credit-Scoring

Calculate consumer FICO credit score

Parameters

NameTypeRequiredDescription
AuthorizationstringYes

Request Body

Responses

200 - Successful response

400 - Bad request

401 - Unauthorized

500 - Internal server error

1// Calculate FICO Score 2const response = await axios.post( 3 'https://api.vectorml.com/v1/credit-risk/consumer-scoring/fico/calculate', 4 {}, 5 { 6 headers: { 7 'Authorization': 'Bearer YOUR_API_KEY', 8 'Content-Type': 'application/json' 9 } 10 } 11); 12 13console.log(response.data);
200OK

Successful response

{ "success": true, "message": "Operation completed successfully", "timestamp": "2024-12-23T10:30:00.000Z", "request_id": "req_jkl012" }
POST

Pull Credit Bureau Report

/credit-risk/consumer-scoring/bureau/pull
/1.1.2Consumer-Credit-Scoring

Pull credit bureau report (Equifax/Experian/TransUnion)

Parameters

NameTypeRequiredDescription
AuthorizationstringYes

Request Body

Responses

200 - Successful response

400 - Bad request

401 - Unauthorized

500 - Internal server error

1// Pull Credit Bureau Report 2const response = await axios.post( 3 'https://api.vectorml.com/v1/credit-risk/consumer-scoring/bureau/pull', 4 {}, 5 { 6 headers: { 7 'Authorization': 'Bearer YOUR_API_KEY', 8 'Content-Type': 'application/json' 9 } 10 } 11); 12 13console.log(response.data);
200OK

Successful response

{ "success": true, "message": "Operation completed successfully", "timestamp": "2024-12-23T10:30:00.000Z", "request_id": "req_jkl012" }
GET

Get Score History

/credit-risk/consumer-scoring/{customerId}/history
/1.1.3Consumer-Credit-Scoring

Get consumer credit score history

Parameters

NameTypeRequiredDescription
AuthorizationstringYes

Responses

200 - Successful response

400 - Bad request

401 - Unauthorized

500 - Internal server error

1// Get Score History 2const response = await axios.get( 3 'https://api.vectorml.com/v1/credit-risk/consumer-scoring/{customerId}/history', 4 { 5 headers: { 6 'Authorization': 'Bearer YOUR_API_KEY', 7 'Content-Type': 'application/json' 8 } 9 } 10); 11 12console.log(response.data);
200OK

Successful response

{ "success": true, "message": "Operation completed successfully", "timestamp": "2024-12-23T10:30:00.000Z", "request_id": "req_jkl012" }
POST

Batch Score Consumers

/credit-risk/consumer-scoring/batch
/1.1.4Consumer-Credit-Scoring

Score multiple consumers in batch

Parameters

NameTypeRequiredDescription
AuthorizationstringYes

Request Body

Responses

200 - Successful response

400 - Bad request

401 - Unauthorized

500 - Internal server error

1// Batch Score Consumers 2const response = await axios.post( 3 'https://api.vectorml.com/v1/credit-risk/consumer-scoring/batch', 4 {}, 5 { 6 headers: { 7 'Authorization': 'Bearer YOUR_API_KEY', 8 'Content-Type': 'application/json' 9 } 10 } 11); 12 13console.log(response.data);
200OK

Successful response

{ "success": true, "message": "Operation completed successfully", "timestamp": "2024-12-23T10:30:00.000Z", "request_id": "req_jkl012" }
POST

Generate Adverse Action

/credit-risk/consumer-scoring/adverse-action
/1.1.5Consumer-Credit-Scoring

Generate FCRA adverse action codes

Parameters

NameTypeRequiredDescription
AuthorizationstringYes

Request Body

Responses

200 - Successful response

400 - Bad request

401 - Unauthorized

500 - Internal server error

1// Generate Adverse Action 2const response = await axios.post( 3 'https://api.vectorml.com/v1/credit-risk/consumer-scoring/adverse-action', 4 {}, 5 { 6 headers: { 7 'Authorization': 'Bearer YOUR_API_KEY', 8 'Content-Type': 'application/json' 9 } 10 } 11); 12 13console.log(response.data);
200OK

Successful response

{ "success": true, "message": "Operation completed successfully", "timestamp": "2024-12-23T10:30:00.000Z", "request_id": "req_jkl012" }
POST

Apply Score Override

/credit-risk/consumer-scoring/override
/1.1.6Consumer-Credit-Scoring

Apply manual credit score override

Parameters

NameTypeRequiredDescription
AuthorizationstringYes

Request Body

Responses

200 - Successful response

400 - Bad request

401 - Unauthorized

500 - Internal server error

1// Apply Score Override 2const response = await axios.post( 3 'https://api.vectorml.com/v1/credit-risk/consumer-scoring/override', 4 {}, 5 { 6 headers: { 7 'Authorization': 'Bearer YOUR_API_KEY', 8 'Content-Type': 'application/json' 9 } 10 } 11); 12 13console.log(response.data);
200OK

Successful response

{ "success": true, "message": "Operation completed successfully", "timestamp": "2024-12-23T10:30:00.000Z", "request_id": "req_jkl012" }
GET

Get Score Factors

/credit-risk/consumer-scoring/{scoreId}/factors
/1.1.7Consumer-Credit-Scoring

Get factors impacting credit score

Parameters

NameTypeRequiredDescription
AuthorizationstringYes

Responses

200 - Successful response

400 - Bad request

401 - Unauthorized

500 - Internal server error

1// Get Score Factors 2const response = await axios.get( 3 'https://api.vectorml.com/v1/credit-risk/consumer-scoring/{scoreId}/factors', 4 { 5 headers: { 6 'Authorization': 'Bearer YOUR_API_KEY', 7 'Content-Type': 'application/json' 8 } 9 } 10); 11 12console.log(response.data);
200OK

Successful response

{ "success": true, "message": "Operation completed successfully", "timestamp": "2024-12-23T10:30:00.000Z", "request_id": "req_jkl012" }
POST

Calculate VantageScore

/credit-risk/consumer-scoring/vantage/calculate
/1.1.8Consumer-Credit-Scoring

Calculate VantageScore 3.0/4.0

Parameters

NameTypeRequiredDescription
AuthorizationstringYes

Request Body

Responses

200 - Successful response

400 - Bad request

401 - Unauthorized

500 - Internal server error

1// Calculate VantageScore 2const response = await axios.post( 3 'https://api.vectorml.com/v1/credit-risk/consumer-scoring/vantage/calculate', 4 {}, 5 { 6 headers: { 7 'Authorization': 'Bearer YOUR_API_KEY', 8 'Content-Type': 'application/json' 9 } 10 } 11); 12 13console.log(response.data);
200OK

Successful response

{ "success": true, "message": "Operation completed successfully", "timestamp": "2024-12-23T10:30:00.000Z", "request_id": "req_jkl012" }
POST

Compare Score Models

/credit-risk/consumer-scoring/models/compare
/1.1.9Consumer-Credit-Scoring

Compare scores across model versions

Parameters

NameTypeRequiredDescription
AuthorizationstringYes

Request Body

Responses

200 - Successful response

400 - Bad request

401 - Unauthorized

500 - Internal server error

1// Compare Score Models 2const response = await axios.post( 3 'https://api.vectorml.com/v1/credit-risk/consumer-scoring/models/compare', 4 {}, 5 { 6 headers: { 7 'Authorization': 'Bearer YOUR_API_KEY', 8 'Content-Type': 'application/json' 9 } 10 } 11); 12 13console.log(response.data);
200OK

Successful response

{ "success": true, "message": "Operation completed successfully", "timestamp": "2024-12-23T10:30:00.000Z", "request_id": "req_jkl012" }
GET

Get Consumer Score Dashboard

/credit-risk/consumer-scoring/dashboard
/1.1.10Consumer-Credit-Scoring

Get consumer scoring dashboard

Parameters

NameTypeRequiredDescription
AuthorizationstringYes

Responses

200 - Successful response

400 - Bad request

401 - Unauthorized

500 - Internal server error

1// Get Consumer Score Dashboard 2const response = await axios.get( 3 'https://api.vectorml.com/v1/credit-risk/consumer-scoring/dashboard', 4 { 5 headers: { 6 'Authorization': 'Bearer YOUR_API_KEY', 7 'Content-Type': 'application/json' 8 } 9 } 10); 11 12console.log(response.data);
200OK

Successful response

{ "success": true, "message": "Operation completed successfully", "timestamp": "2024-12-23T10:30:00.000Z", "request_id": "req_jkl012" }