Get credit profile verification checks and report history for a merchant. Returns 7 Experian checks (Address, Bankruptcy, DOB, Fraud, Name, Score, SSN) and a list of credit profile report runs.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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

ParameterTypeRequiredDescription
idinteger (int32)YesMerchant profile ID

Response

200 OK

FieldTypeDescription
data.checksarrayList of 7 Experian verification check results
data.checks[].verificationTypestringCheck category: Address, Bankruptcy, DOB, Fraud, Name, Score, SSN
data.checks[].querystringThe query value submitted to Experian
data.checks[].scanResultstringRaw result returned by Experian
data.checks[].merchantApplicationRequirementstringWhat the application requires for this check
data.checks[].verificationResultstringFinal verification outcome: Pass, Fail, Review
data.reportsarrayList of credit profile report runs
data.reports[].reportIdstringUnique report ID — use with GET /creditProfile/report to download
data.reports[].createdDatestring (date-time)When the report was generated
data.reports[].createdBystringUser or system that triggered the report
data.reports[].outputTypestringReport format, e.g. PDF, XML
data.reports[].statusstringReport status: Completed, Pending, Failed
requestIdintegerUnique request identifier for tracing
successbooleantrue if request succeeded
errorstringError 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

CodeWhen it happens
400id parameter missing or invalid
401Invalid or missing Basic Auth credentials
403User does not have Underwriting access
404Merchant profile not found
500Internal server error

Common Mistakes

  • Forgetting to trigger a soft pull first via POST /creditProfile/softPull — if no pull has been run, the checks array may be empty or contain stale data.
  • Using the wrong id — this is merchantProfileId, 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

Example

curl -X GET "https://hq.staging.netevia.dev/api/v1/merchant/creditProfile?id=161787" \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)"
Query Params
int32
required

Merchant profile ID

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json