Skip to content

Bulk (v1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://developer.reged.com/_mock/apis/producer-bulk-api/openapi

Bulk

Operations

Gets the status of a bulk request

Request

Returns the processing status and outcome of a bulk import request

Path
bulkRequestIdstring(uuid)required

A GUID request ID from a prior bulk import request

curl -i -X GET \
  'https://developer.reged.com/_mock/apis/producer-bulk-api/openapi/bulk/v1/status/{bulkRequestId}'

Responses

Complete success or failure

Bodyapplication/json
bulkRequestIdstring(uuid)
processingStatusstring or null
operationDetailsobject(OperationDetails)
Response
application/json
{
  "bulkRequestId": "ca2d67b6-6a2a-4776-867a-9d57644265d4",
  "processingStatus": "COMPLETE",
  "operationDetails": {
    "status": "SUCCESS",
    "totalItems": 2,
    "success": 2,
    "failures": 0,
    "requestItems": [ … ]
  }
}

Submit a new bulk of items to import

Request

For the provided itemType will import a batch of item records.

Path
itemTypestringrequired

Must be one of the following supported types: profile

Bodyapplication/x-ndjsOnrequired
any(string)

Paste your NDJSON here. One JSON object per line.

curl -i -X POST \
  'https://developer.reged.com/_mock/apis/producer-bulk-api/openapi/bulk/v1/{itemType}' \
  -H 'Content-Type: application/x-ndjsOn' \
  -d '{"clientRefId" :"1F55AA75-5D53-4B6C-BFD2-B56764387E84","data":{"agent":{"contact":{"additionalEmailAddress":"","businessEmailAddress":"qa@reged.com","businessFaxNumber":"1112223331","businessPhoneExtension":"111","businessPhoneNumber":"17549127046","cellPhoneNumber":"17549127046","homeEmailAddress":"qa@reged.com","homeFaxNumber":"1112223331","homePhoneNumber":"17549127046","suppressEmail":"N"},"demographic":{"affiliatedWithBank":"Y","agentProfileKey":"10722589","alias":"string","backOfficeNrf":"N","billingCode":"001","branchLocation":"NY","cityOfBirth":"NY","costCenter":"string","country":"string","countryOfBirth":"string","crdNumber":"123124","customField1":"string","customField2":"string","customField3":"string","customField4":"string","customField5":"string","customField6":"string","customField7":"string","customField8":"string","customField9":"string","customField10":"string","deptNumber":"string","driverLicenseNumber":"1234567890","driverLicenseState":"NY","employerId":"23","employersFein":"88888888","empStatus":"7040","firstName":"7","gender":"M","iaSupervisorName":"string","iaSupervisorPhoneNumber":"","iaSupervisorTitle":"string","jobTitle":"QA","lastName":"ordanovichTested1","middleInitial":"MiddleName1","niprNumber":"8888888","nmlsRegPriorFirmYn":"string","nmlsRenewalStatus":"7040","residentState":"NY","rfoCode":"NY","salutation":"Mr","stateOfBirth":"NY","suffix":"string"},"profileKey":"107225822","ssn":"107225822"}}}
  {"clientRefId" :"AEE4C1D7-ABD6-4CA3-BAC4-B62013E7FCFE","data":{"agency":{"demographic":{"affiliatedWithBank":"Y","businessFax":"1112223331","businessPhone":"2112223331","costCenter":"2411","firmBillingCode":"3024","customField1":"1string","customField2":"2string","customField3":"3string","dbaName":"test","domicileCountry":"USA","domicileState":"FL","emailAddress":"qa@reged.com","firmCrd":"202525","firmId":"3202524","firmName":"Create API","incorporationDate":"2010-08-24T14:15:22Z","nipr":"60524","organizationDate":"2011-08-24T14:15:22Z","organizationType":23017,"parentFirmProfileKey":"","region":"GA","startDate":"2012-08-24T14:15:22Z","status":7040,"terminationDate":"2029-08-24T14:15:22Z","webAddress":"qa@reged.com"},"profileKey":"204823730","tin":"204823730"}}}
  {"clientRefId" :"C98AA4B9-D29C-4ACC-B41E-6DCDAE134E0C","data":{"agent":{"contact":{"additionalEmailAddress":"qa@reged.com","businessEmailAddress":"qa@reged.com","businessFaxNumber":"1112223331","businessPhoneExtension":"111","businessPhoneNumber":"17549127046","cellPhoneNumber":"17549127046","homeEmailAddress":"qa@reged.com","homeFaxNumber":"1112223331","homePhoneNumber":"17549127046","suppressEmail":"N"},"demographic":{"affiliatedWithBank":"Y","agentProfileKey":"10722589","alias":"string","backOfficeNrf":"N","billingCode":"001","branchLocation":"NY","cityOfBirth":"NY","costCenter":"string","country":"string","countryOfBirth":"string","crdNumber":"123124","customField1":"string","customField2":"string","customField3":"string","customField4":"string","customField5":"string","customField6":"string","customField7":"string","customField8":"string","customField9":"string","customField10":"string","deptNumber":"string","driverLicenseNumber":"1234567890","driverLicenseState":"NY","employerId":"23","employersFein":"88888888","empStatus":"7040","firstName":"7","gender":"M","iaSupervisorName":"string","iaSupervisorPhoneNumber":"","iaSupervisorTitle":"string","jobTitle":"QA","lastName":"ordanovichTested1","middleInitial":"MiddleName1","niprNumber":"8888888","nmlsRegPriorFirmYn":"string","nmlsRenewalStatus":"7040","residentState":"NY","rfoCode":"NY","salutation":"Mr","stateOfBirth":"NY","suffix":"string"},"profileKey":"107225822","ssn":"107225822"}}}
  {"clientRefId" :"66A830F4-0CBF-478C-9F6D-58AFAADB0F9F","data":{"agent":{"contact":{"additionalEmailAddress":"qa@reged.com","businessEmailAddress":"qa@reged.com","businessFaxNumber":"1112223331","businessPhoneExtension":"111","businessPhoneNumber":"17549127046","cellPhoneNumber":"17549127046","homeEmailAddress":"qa@reged.com","homeFaxNumber":"1112223331","homePhoneNumber":"17549127046","suppressEmail":"N"},"demographic":{"affiliatedWithBank":"Y","agentProfileKey":"10722589","alias":"string","backOfficeNrf":"N","billingCode":"001","branchLocation":"NY","cityOfBirth":"NY","costCenter":"string","country":"string","countryOfBirth":"string","crdNumber":"123124","customField1":"string","customField2":"string","customField3":"string","customField4":"string","customField5":"string","customField6":"string","customField7":"string","customField8":"string","customField9":"string","customField10":"string","deptNumber":"string","driverLicenseNumber":"1234567890","driverLicenseState":"NY","employerId":"23","employersFein":"88888888","empStatus":"7040","firstName":"7","gender":"M","iaSupervisorName":"string","iaSupervisorPhoneNumber":"","iaSupervisorTitle":"string","jobTitle":"QA","lastName":"ordanovichTested1","middleInitial":"MiddleName1","niprNumber":"8888888","nmlsRegPriorFirmYn":"string","nmlsRenewalStatus":"7040","residentState":"NY","rfoCode":"NY","salutation":"Mr","stateOfBirth":"NY","suffix":"string"},"profileKey":"107225822","ssn":"107225822"}}}'

Responses

Accepted