Skip to content
Connect API Catalog/
/
/
Create Job Request

Create Job Request

Request

Enter a name for the 'Job Request' to be associated to the file going to be processed.

Security
bearerToken
Bodyapplication:jsonrequired
namestringrequired

Name for the Data Cleaning job to create.

owningCompanyNamestring

Company name associated with the job owner.

sourcestring

Source system creating the job. Defaults to DataCleaning when omitted.

Default:"DataCleaning"
curl -i -X POST \
  https://connect.sandbox.creditsafe.com/v1/dataCleaning/jobs \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application:json' \
  -d '{
    "name": "Create a Data Cleaning Job 03-10-20xx"
  }'

Responses

Successful Response

Bodyapplication/json
idstring

Unique identifier of the Data Cleaning job.

namestring

Name of the Data Cleaning job.

createdAtstring, (date-time)

Date and time when the job was created.

modifiedAtstring, (date-time)

Date and time when the job was last modified.

managingUserIdinteger, (int32)

User ID currently managing the job.

managingCustomerIdinteger, (int32)

Customer ID currently managing the job.

owningCustomerIdinteger, (int32)

Customer ID that owns the job.

owningUserIdinteger, (int32)

User ID that owns the job.

owningCompanyNamestring

Company name that owns the job.

statusstring

Current status of the job.

Enum:"created""uploading""uploadError""uploaded""ready""matching""matchingError""matched""addingToPortfolio""addedToPortfolio"
Example:"created"
countryCodestring

Country code associated with the job.

portfolioIdstring

Portfolio identifier associated with the job.

sourcestring

Source system that created the job.

Enum:"dataCleaning""prospects"
Example:"dataCleaning"
jobSummaryobject

Row-level matching summary for the uploaded job data.

jobEnrichmentSettingsobject

Enrichment settings used for the job.

archivedboolean

Indicates whether the job is archived.

owningUserAccountStatusstring

Account status of the owning user.

Response
{
  "id": "string",
  "name": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "modifiedAt": "2019-08-24T14:15:22Z",
  "managingUserId": 0,
  "managingCustomerId": 0,
  "owningCustomerId": 0,
  "owningUserId": 0,
  "owningCompanyName": "string",
  "status": "created",
  "countryCode": "string",
  "portfolioId": "string",
  "source": "dataCleaning",
  "jobSummary": {
    "totalRows": 0,
    "matched": 0,
    "manualMatched": 0,
    "unmatched": 0,
    "duplicates": 0
  },
  "jobEnrichmentSettings": {
    "headquarters": "string",
    "creditType": "string",
    "dE_Reason": { … },
    "algorithmBanding": [ … ],
    "countries": [ … ]
  },
  "archived": true,
  "owningUserAccountStatus": "string"
}