Skip to content

Producer Database Search (v1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://reged-developer-portal.redocly.app/_mock/apis/producer-pdb-search/openapi/

ProducerPdbSearch

Operations

/producerpdbsearch/v1/agent/search

Request

Body
SearchTypestring(SearchTypeEnum)
Enum"NAME""SSN""NPN""LICENSE"
FirstNamestring or null[ 0 .. 80 ] characters

required if SearchType is NAME

MiddleNamestring or null[ 0 .. 30 ] characters
LastNamestring or null[ 0 .. 80 ] characters

required if SearchType is NAME or SSN

Ssnstring or null[ 0 .. 12 ] characters([0-9]+)

required if SearchType is SSN

Npninteger or null(int32)

required if SearchType is NPN

LicenseJurisdictionstring or null

required if SearchType is LICENSE

LicenseNumberstring or null[ 0 .. 30 ] characters

required if SearchType is LICENSE

CostCenterstring or null[ 0 .. 50 ] characters
curl -i -X POST \
  https://reged-developer-portal.redocly.app/_mock/apis/producer-pdb-search/openapi/producerpdbsearch/v1/agent/search \
  -H 'Content-Type: application/json' \
  -d '{
    "SearchType": "NAME",
    "FirstName": "John",
    "MiddleName": null,
    "LastName": "Smith",
    "Ssn": null,
    "Npn": null,
    "LicenseJurisdiction": null,
    "LicenseNumber": null,
    "CostCenter": null
  }'

Responses

OK

Body
IndividualsSummaryInfoobject(NiprIndividualsSummaryInfo)
AdditionalInfoobject(NiprAdditionalInfo)
Response
{
  "IndividualsSummaryInfo": {
    "TransactionType": { … },
    "Individuals": [ … ]
  },
  "AdditionalInfo": {
    "TransactionType": { … },
    "Entity": { … }
  }
}

/producerpdbsearch/v1/agency/search

Request

Body
SearchTypestring(SearchTypeEnum)
Enum"NAME""SSN""NPN""LICENSE"
FirmNamestring or null[ 0 .. 150 ] characters

required if SearchType is NAME

FirmFeinstring or null[ 0 .. 12 ] characters([0-9\-]+)

required if SearchType is NAME

LicenseJurisdictionstring or null

required if SearchType is LICENSE

LicenseNumberstring or null[ 0 .. 30 ] characters

required if SearchType is LICENSE

CostCenterstring or null[ 0 .. 50 ] characters
curl -i -X POST \
  https://reged-developer-portal.redocly.app/_mock/apis/producer-pdb-search/openapi/producerpdbsearch/v1/agency/search \
  -H 'Content-Type: application/json' \
  -d '{
    "SearchType": "NAME",
    "FirmName": "Firm Name",
    "FirmFein": "123456789",
    "LicenseJurisdiction": null,
    "LicenseNumber": null,
    "CostCenter": null
  }'

Responses

OK

Body
NiprFirmsSummaryInfoobject(NiprFirmsSummaryInfo)
AdditionalInfoobject(NiprAdditionalInfo)
Response
{
  "NiprFirmsSummaryInfo": {
    "TransactionType": { … },
    "Firms": [ … ]
  },
  "AdditionalInfo": {
    "TransactionType": { … },
    "Entity": { … }
  }
}

/producerpdbsearch/v1/agent

Request

Query
Npninteger(int32)required

National Producer Number (NPN)

CostCenterstring[ 0 .. 50 ] characters

Account specific cost center

curl -i -X GET \
  'https://reged-developer-portal.redocly.app/_mock/apis/producer-pdb-search/openapi/producerpdbsearch/v1/agent?Npn=0&CostCenter=string'

Responses

OK

Body
NiprFullInfoobject(NiprFullInfo)
Response
{
  "NiprFullInfo": {
    "TransactionType": { … },
    "Producer": { … },
    "Biographic": { … },
    "Organization": [ … ],
    "LastUpdated": null,
    "AddressInfo": { … },
    "LicenseData": { … }
  }
}

/producerpdbsearch/v1/agency

Request

Query
Npninteger(int32)required

National Producer Number (NPN)

CostCenterstring[ 0 .. 50 ] characters

Account specific cost center

curl -i -X GET \
  'https://reged-developer-portal.redocly.app/_mock/apis/producer-pdb-search/openapi/producerpdbsearch/v1/agency?Npn=0&CostCenter=string'

Responses

OK

Body
NiprFullInfoobject(NiprFullInfo)
Response
{
  "NiprFullInfo": {
    "TransactionType": { … },
    "Producer": { … },
    "Biographic": { … },
    "Organization": [ … ],
    "LastUpdated": null,
    "AddressInfo": { … },
    "LicenseData": { … }
  }
}