| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Get Credit Profile
Retrieves Experian-based credit profile verification checks and a history of credit profile report runs for a specific merchant. Returns 7 verification check categories and a list of previously generated report runs that can be downloaded individually.
Endpoint
GET /api/v1/merchant/creditProfile
Authentication
Basic HTTP Authentication required. Encode username:password in Base64 and pass in the Authorization header:
Authorization: Basic {base64(username:password)}
When to use
Use this endpoint during the underwriting process to review a merchant's Experian credit verification results. It provides a quick overview of all 7 check categories (Address, Bankruptcy, DOB, Fraud, Name, Score, SSN) and a list of report runs with their status, so underwriters can decide whether to proceed, request additional documents, or trigger a new soft pull.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer (int32) | Yes | Merchant profile ID |
Response
200 OK
| Field | Type | Description |
|---|---|---|
| data.checks | array | List of 7 Experian verification check results |
| data.checks[].verificationType | string | Check category: Address, Bankruptcy, DOB, Fraud, Name, Score, SSN |
| data.checks[].query | string | The query value submitted to Experian |
| data.checks[].scanResult | string | Raw result returned by Experian |
| data.checks[].merchantApplicationRequirement | string | What the application requires for this check |
| data.checks[].verificationResult | string | Final verification outcome: Pass, Fail, Review |
| data.reports | array | List of credit profile report runs |
| data.reports[].reportId | string | Unique report ID — use with GET /creditProfile/report to download |
| data.reports[].createdDate | string (date-time) | When the report was generated |
| data.reports[].createdBy | string | User or system that triggered the report |
| data.reports[].outputType | string | Report format, e.g. PDF, XML |
| data.reports[].status | string | Report status: Completed, Pending, Failed |
| requestId | integer | Unique request identifier for tracing |
| success | boolean | true if request succeeded |
| error | string | Error message if success is false |
{
"data": {
"checks": [
{
"verificationType": "Address",
"query": "53 North 11th Street, Philadelphia, PA 19107",
"scanResult": "Match",
"merchantApplicationRequirement": "Address must match records",
"verificationResult": "Pass"
},
{
"verificationType": "Bankruptcy",
"query": "FAMILY SALON LLC",
"scanResult": "No records found",
"merchantApplicationRequirement": "No active bankruptcy",
"verificationResult": "Pass"
},
{
"verificationType": "Score",
"query": "XXX-XX-XXXX",
"scanResult": "720",
"merchantApplicationRequirement": "Score >= 600",
"verificationResult": "Pass"
},
{
"verificationType": "SSN",
"query": "XXX-XX-XXXX",
"scanResult": "Match",
"merchantApplicationRequirement": "SSN must be valid",
"verificationResult": "Pass"
}
],
"reports": [
{
"reportId": "rpt-8f3a2c1d",
"createdDate": "2024-10-15T09:23:41Z",
"createdBy": "[email protected]",
"outputType": "PDF",
"status": "Completed"
}
]
},
"requestId": 4187234,
"success": true,
"error": null
}Error Codes
| Code | When it happens |
|---|---|
| 400 | id parameter missing or invalid |
| 401 | Invalid or missing Basic Auth credentials |
| 403 | User does not have Underwriting access |
| 404 | Merchant profile not found |
| 500 | Internal server error |
Common Mistakes
- Forgetting to trigger a soft pull first via
POST /creditProfile/softPull— if no pull has been run, thechecksarray may be empty or contain stale data. - Using the wrong
id— this ismerchantProfileId, not the merchant's MID or agent ID. - Expecting real-time data — results reflect the last completed soft pull, not live Experian data.
Related Endpoints
POST /api/v1/merchant/creditProfile/softPull— trigger a new soft pull before calling this endpointGET /api/v1/merchant/creditProfile/report— download full report content byreportIdGET /api/v1/merchant/bladeReview— get broader Blade verification results including OFAC, TINCheck, MaxMind
Example
curl -X GET "https://hq.staging.netevia.dev/api/v1/merchant/creditProfile?id=161787" \
-H "Authorization: Basic $(echo -n 'username:password' | base64)"