SignCare

Credit Data

2 endpoints · WealthSync API

POST

/pfm/api/v2/creditdata/subscribe

#

Subscribe user for credit data tracking.

docs.signcare.io/wealthsync/api/credit-data/#post-pfm-api-v2-creditdata-subscribe

This API subscribes a user for credit data monitoring. Once subscribed, Wealthsync will periodically fetch the user's credit report from bureaus. Use this before calling the credit data insights API.

Request Body Parameters:

→ uniqueIdentifier (required): The primary identifier added at the time of subscription. It must be the exact same value used during the initial subscription and MUST never change for this user.

→ mobileNumber (required): The user's 10-digit mobile number. Example: "9999999999".

→ name (required): The user's full name. Example: "John Doe".

→ pan (required): The user's 10-character PAN in the format AAAAA9999A. Example: "ABCDE1234F".

→ subscriptionStatus (required): Exactly "ACTIVE" to activate or "INACTIVE" to deactivate credit data tracking (upper case).

→ subscriptionEndDate (optional): The date until which the subscription is valid. Send a date such as "2026-12-31" (a full ISO 8601 date-time is also accepted).

Headers

  • X-API-KEY
    stringrequired
    Your secret API key for the environment you are calling (Stage and Live use different keys).
  • X-API-APP-ID
    stringrequired
    The App ID issued together with the key.
  • Content-Type
    stringrequired
    application/json

Body parameters

application/json
  • uniqueIdentifier
    stringrequired
    Required. Your identifier for the user, exactly as sent when the user was subscribed. Never changes for a user. Non-empty string.
    minLength 1default user-12345
  • mobileNumber
    stringrequired
    Required. The user's 10-digit mobile number.
    nullabledefault 9999999999
  • name
    stringrequired
    Required. The user's full name.
    nullabledefault John Doe
  • pan
    stringrequired
    Required. 10-character PAN of the user in the format AAAAA9999A.
    nullabledefault ABCDE1234F
  • subscriptionStatus
    stringrequired
    Required. Exactly "ACTIVE" to start credit data tracking or "INACTIVE" to stop it (upper case).
    nullabledefault ACTIVE
  • subscriptionEndDate
    string (date-time)optional
    Optional. Date until which the subscription is valid, for example 2026-12-31 (a full ISO 8601 date-time is also accepted).
    nullable
Sample request body
{ "uniqueIdentifier": "user-12345", "mobileNumber": "9999999999", "name": "John Doe", "pan": "ABCDE1234F", "subscriptionStatus": "ACTIVE" }

Responses

200OK
  • uniqueIdentifier
    stringoptional
    No description.
    nullable
  • subscriptionStatus
    stringoptional
    No description.
    nullable
  • subscriptionEndDate
    string (date-time)optional
    No description.
    nullable
Example
{ "uniqueIdentifier": "string", "subscriptionStatus": "string", "subscriptionEndDate": "2026-01-01T00:00:00Z" }
400Bad Request
  • data
    objectoptional
    No description.
  • messages
    array<string>optional
    No description.
    nullable
  • request_id
    stringoptional
    No description.
    nullable
  • success
    booleanoptional
    No description.
    default false
  • message
    stringoptional
    No description.
    nullabledefault XXXXX
  • isBillable
    booleanoptional
    No description.
  • statusCode
    integer (int32)optional
    No description.
    default 400
Example
{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 400 }
401Unauthorized
  • data
    objectoptional
    No description.
  • messages
    array<string>optional
    No description.
    nullable
  • request_id
    stringoptional
    No description.
    nullable
  • success
    booleanoptional
    No description.
    default false
  • message
    stringoptional
    No description.
    nullabledefault XXXXX
  • isBillable
    booleanoptional
    No description.
  • statusCode
    integer (int32)optional
    No description.
    default 401
Example
{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 401 }
500Internal Server Error
  • data
    objectoptional
    No description.
  • messages
    array<string>optional
    No description.
    nullable
  • request_id
    stringoptional
    No description.
    nullable
  • success
    booleanoptional
    No description.
    default false
  • message
    stringoptional
    No description.
    nullabledefault XXXXX
  • isBillable
    booleanoptional
    No description.
  • statusCode
    integer (int32)optional
    No description.
    default 500
Example
{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 500 }
Code samplescurl · Node.js · Python
Stage: uat-ext.signcare.io
curl -X POST 'https://uat-ext.signcare.io/pfm/api/v2/creditdata/subscribe' \ -H 'X-API-KEY: YOUR_API_KEY' \ -H 'X-API-APP-ID: YOUR_APP_ID' \ -H 'Content-Type: application/json' \ -d '{ "uniqueIdentifier": "user-12345", "mobileNumber": "9999999999", "name": "John Doe", "pan": "ABCDE1234F", "subscriptionStatus": "ACTIVE" }'
POST

/pfm/api/v2/creditdata/insights

#

Get credit data insights including credit score and liabilities.

docs.signcare.io/wealthsync/api/credit-data/#post-pfm-api-v2-creditdata-insights

This API returns the user's credit data insights fetched from credit bureaus. The response includes personal info, credit score (score, confidence, date), a summary of all accounts, liabilities (loan details, delinquency info, repayment history), and credit enquiries.

Prerequisites: → The user must be subscribed for credit data tracking via POST creditdata/subscribe.

Request Body Parameters:

→ uniqueIdentifier (required): The primary identifier added at the time of subscription. It must be the exact same value used during the initial subscription and MUST never change for this user.

Headers

  • X-API-KEY
    stringrequired
    Your secret API key for the environment you are calling (Stage and Live use different keys).
  • X-API-APP-ID
    stringrequired
    The App ID issued together with the key.
  • Content-Type
    stringrequired
    application/json

Body parameters

application/json
  • uniqueIdentifier
    stringrequired
    Required. Your identifier for the user, exactly as sent when the user was subscribed. Never changes for a user. Non-empty string.
    minLength 1default user-12345
Sample request body
{ "uniqueIdentifier": "user-12345" }

Responses

200OK
  • personalInfoAsOnReport
    objectoptional
    No description.
    11 fields
    • firstName
      stringoptional
      No description.
      nullable
    • middleName
      stringoptional
      No description.
      nullable
    • lastName
      stringoptional
      No description.
      nullable
    • dateOfBirth
      stringoptional
      No description.
      nullable
    • gender
      stringoptional
      No description.
      nullable
    • mobileNumber
      stringoptional
      No description.
      nullable
    • email
      stringoptional
      No description.
      nullable
    • pan
      stringoptional
      No description.
      nullable
    • passport
      stringoptional
      No description.
      nullable
    • voterId
      stringoptional
      No description.
      nullable
    • drivingLicense
      stringoptional
      No description.
      nullable
  • creditScore
    objectoptional
    No description.
    3 fields
    • score
      integer (int32)optional
      No description.
      nullable
    • scoreConfidence
      stringoptional
      No description.
      nullable
    • scoreDate
      string (date-time)optional
      No description.
      nullable
  • summary
    objectoptional
    No description.
    11 fields
    • totalFiData
      integer (int32)optional
      No description.
      nullable
    • totalFiDataSplit
      objectoptional
      No description.
      nullable
    • totalFiDataToBeFetched
      integer (int32)optional
      No description.
      nullable
    • currentBankBalance
      number (double)optional
      No description.
      nullable
    • totalFIPs
      integer (int32)optional
      No description.
      nullable
    • tdrDMaturityAmount
      number (double)optional
      No description.
      nullable
    • tdrDMaturityAmountSplit
      objectoptional
      No description.
      nullable
    • currentInvestmentValue
      number (double)optional
      No description.
      nullable
    • currentInvestmentValueSplit
      objectoptional
      No description.
      nullable
    • tdrdMaturityAmount
      number (double)optional
      No description.
      nullable
    • tdrdMaturityAmountSplit
      objectoptional
      No description.
      nullable
  • liabilities
    array<object>optional
    No description.
    nullable
    Each item: 18 fields
    • identificationNumber
      stringoptional
      No description.
      nullable
    • lenderName
      stringoptional
      No description.
      nullable
    • accountNumberMasked
      stringoptional
      No description.
      nullable
    • portfolioType
      stringoptional
      No description.
      nullable
    • accountType
      stringoptional
      No description.
      nullable
    • ownershipType
      stringoptional
      No description.
      nullable
    • openDate
      string (date-time)optional
      No description.
      nullable
    • closeDate
      string (date-time)optional
      No description.
      nullable
    • status
      stringoptional
      No description.
      nullable
    • currency
      stringoptional
      No description.
      nullable
    • dateReported
      string (date-time)optional
      No description.
      nullable
    • dateOfAddition
      string (date-time)optional
      No description.
      nullable
    • loanDetails
      objectoptional
      No description.
      11 fields
      • sanctionedAmount
        stringoptional
        No description.
        nullable
      • creditLimit
        stringoptional
        No description.
        nullable
      • currentBalance
        stringoptional
        No description.
        nullable
      • amountPastDue
        stringoptional
        No description.
        nullable
      • repaymentTenureMonths
        stringoptional
        No description.
        nullable
      • rateOfInterest
        stringoptional
        No description.
        nullable
      • scheduledMonthlyPayment
        stringoptional
        No description.
        nullable
      • lastPaymentDate
        stringoptional
        No description.
        nullable
      • settlementAmount
        stringoptional
        No description.
        nullable
      • collateralValue
        stringoptional
        No description.
        nullable
      • collateralType
        stringoptional
        No description.
        nullable
    • delinquencyInfo
      objectoptional
      No description.
      7 fields
      • highestDpd
        stringoptional
        No description.
        nullable
      • dateOfFirstDelinquency
        stringoptional
        No description.
        nullable
      • writtenOffTotal
        stringoptional
        No description.
        nullable
      • writtenOffPrincipal
        stringoptional
        No description.
        nullable
      • suitFiledStatus
        stringoptional
        No description.
        nullable
      • defaultStatusDate
        stringoptional
        No description.
        nullable
      • writeoffStatusDate
        stringoptional
        No description.
        nullable
    • repaymentHistory
      array<object>optional
      No description.
      nullable
      Each item: 4 fields
      • year
        stringoptional
        No description.
        nullable
      • month
        stringoptional
        No description.
        nullable
      • dpd
        stringoptional
        No description.
        nullable
      • assetClassification
        stringoptional
        No description.
        nullable
    • holderInfo
      array<object>optional
      No description.
      nullable
      Each item: 4 fields
      • name
        stringoptional
        No description.
        nullable
      • dob
        string (date-time)optional
        No description.
        nullable
      • gender
        stringoptional
        No description.
        nullable
      • pan
        stringoptional
        No description.
        nullable
    • communicationInfo
      array<object>optional
      No description.
      nullable
      Each item: 2 fields
      • email
        stringoptional
        No description.
        nullable
      • mobile
        integer (int64)optional
        No description.
        nullable
    • address
      array<object>optional
      No description.
      nullable
      Each item: 7 fields
      • line1
        stringoptional
        No description.
        nullable
      • line2
        stringoptional
        No description.
        nullable
      • line3
        stringoptional
        No description.
        nullable
      • city
        stringoptional
        No description.
        nullable
      • state
        stringoptional
        No description.
        nullable
      • pincode
        stringoptional
        No description.
        nullable
      • country
        stringoptional
        No description.
        nullable
  • enquiries
    objectoptional
    No description.
    2 fields
    • summary
      objectoptional
      No description.
      3 fields
      • totalEnquiries
        objectoptional
        No description.
        4 fields
        • last7Days
          integer (int32)optional
          No description.
          nullable
        • last30Days
          integer (int32)optional
          No description.
          nullable
        • last90Days
          integer (int32)optional
          No description.
          nullable
        • last180Days
          integer (int32)optional
          No description.
          nullable
      • creditEnquiries
        objectoptional
        No description.
        4 fields
        • last7Days
          integer (int32)optional
          No description.
          nullable
        • last30Days
          integer (int32)optional
          No description.
          nullable
        • last90Days
          integer (int32)optional
          No description.
          nullable
        • last180Days
          integer (int32)optional
          No description.
          nullable
      • nonCreditEnquiries
        objectoptional
        No description.
        4 fields
        • last7Days
          integer (int32)optional
          No description.
          nullable
        • last30Days
          integer (int32)optional
          No description.
          nullable
        • last90Days
          integer (int32)optional
          No description.
          nullable
        • last180Days
          integer (int32)optional
          No description.
          nullable
    • enquiryDetails
      array<object>optional
      No description.
      nullable
      Each item: 10 fields
      • lenderCode
        stringoptional
        No description.
        nullable
      • lenderName
        stringoptional
        No description.
        nullable
      • enquiryDate
        stringoptional
        No description.
        nullable
      • enquiryTime
        stringoptional
        No description.
        nullable
      • reportNumber
        stringoptional
        No description.
        nullable
      • enquiryReason
        stringoptional
        No description.
        nullable
      • financePurpose
        stringoptional
        No description.
        nullable
      • amountFinanced
        number (double)optional
        No description.
        nullable
      • tenureMonths
        integer (int32)optional
        No description.
        nullable
      • enquiryType
        stringoptional
        No description.
        nullable
  • fetchedDateTime
    string (date-time)optional
    No description.
    nullable
  • bureauName
    stringoptional
    No description.
    nullable
Example
{ "personalInfoAsOnReport": { "firstName": "string", "middleName": "string", "lastName": "string", "dateOfBirth": "string", "gender": "string", "mobileNumber": "string", "email": "string", "pan": "string", "passport": "string", "voterId": "string", "drivingLicense": "string" }, "creditScore": { "score": 0, "scoreConfidence": "string", "scoreDate": "2026-01-01T00:00:00Z" }, "summary": { "totalFiData": 0, "totalFiDataSplit": {}, "totalFiDataToBeFetched": 0, "currentBankBalance": 0, "totalFIPs": 0, "tdrDMaturityAmount": 0, "tdrDMaturityAmountSplit": {}, "currentInvestmentValue": 0, "currentInvestmentValueSplit": {}, "tdrdMaturityAmount": 0, "tdrdMaturityAmountSplit": {} }, "liabilities": [ { "identificationNumber": "string", "lenderName": "string", "accountNumberMasked": "string", "portfolioType": "string", "accountType": "string", "ownershipType": "string", "openDate": "2026-01-01T00:00:00Z", "closeDate": "2026-01-01T00:00:00Z", "status": "string", "currency": "string", "dateReported": "2026-01-01T00:00:00Z", "dateOfAddition": "2026-01-01T00:00:00Z", "loanDetails": { "sanctionedAmount": "string", "creditLimit": "string", "currentBalance": "string", "amountPastDue": "string", "repaymentTenureMonths": "string", "rateOfInterest": "string", "scheduledMonthlyPayment": "string", "lastPaymentDate": "string", "settlementAmount": "string", "collateralValue": "string", "collateralType": "string" }, "delinquencyInfo": { "highestDpd": "string", "dateOfFirstDelinquency": "string", "writtenOffTotal": "string", "writtenOffPrincipal": "string", "suitFiledStatus": "string", "defaultStatusDate": "string", "writeoffStatusDate": "string" }, "repaymentHistory": [ { "year": "string", "month": "string", "dpd": "string", "assetClassification": "string" } ], "holderInfo": [ { "name": "string", "dob": "2026-01-01T00:00:00Z", "gender": "string", "pan": "string" } ], "communicationInfo": [ { "email": "string", "mobile": 0 } ], "address": [ { "line1": "string", "line2": "string", "line3": "string", "city": "string", "state": "string", "pincode": "string", "country": "string" } ] } ], "enquiries": { "summary": { "totalEnquiries": { "last7Days": 0, "last30Days": 0, "last90Days": 0, "last180Days": 0 }, "creditEnquiries": { "last7Days": 0, "last30Days": 0, "last90Days": 0, "last180Days": 0 }, "nonCreditEnquiries": { "last7Days": 0, "last30Days": 0, "last90Days": 0, "last180Days": 0 } }, "enquiryDetails": [ { "lenderCode": "string", "lenderName": "string", "enquiryDate": "string", "enquiryTime": "string", "reportNumber": "string", "enquiryReason": "string", "financePurpose": "string", "amountFinanced": 0, "tenureMonths": 0, "enquiryType": "string" } ] }, "fetchedDateTime": "2026-01-01T00:00:00Z", "bureauName": "string" }
400Bad Request
  • data
    objectoptional
    No description.
  • messages
    array<string>optional
    No description.
    nullable
  • request_id
    stringoptional
    No description.
    nullable
  • success
    booleanoptional
    No description.
    default false
  • message
    stringoptional
    No description.
    nullabledefault XXXXX
  • isBillable
    booleanoptional
    No description.
  • statusCode
    integer (int32)optional
    No description.
    default 400
Example
{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 400 }
401Unauthorized
  • data
    objectoptional
    No description.
  • messages
    array<string>optional
    No description.
    nullable
  • request_id
    stringoptional
    No description.
    nullable
  • success
    booleanoptional
    No description.
    default false
  • message
    stringoptional
    No description.
    nullabledefault XXXXX
  • isBillable
    booleanoptional
    No description.
  • statusCode
    integer (int32)optional
    No description.
    default 401
Example
{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 401 }
500Internal Server Error
  • data
    objectoptional
    No description.
  • messages
    array<string>optional
    No description.
    nullable
  • request_id
    stringoptional
    No description.
    nullable
  • success
    booleanoptional
    No description.
    default false
  • message
    stringoptional
    No description.
    nullabledefault XXXXX
  • isBillable
    booleanoptional
    No description.
  • statusCode
    integer (int32)optional
    No description.
    default 500
Example
{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 500 }
Code samplescurl · Node.js · Python
Stage: uat-ext.signcare.io
curl -X POST 'https://uat-ext.signcare.io/pfm/api/v2/creditdata/insights' \ -H 'X-API-KEY: YOUR_API_KEY' \ -H 'X-API-APP-ID: YOUR_APP_ID' \ -H 'Content-Type: application/json' \ -d '{ "uniqueIdentifier": "user-12345" }'