/api/organisations/{organisationId}/employees/invite

post https://app.credentially.io/mp/api/organisations/{organisationId}/employees/invite

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

string

firstName

string

lastName

string

title

object

key

string

defaultValue

string

gender

string

MALE FEMALE

birthDate

date

gradeName

object

code

string

name

string

otherGrade

string

medicalCategory

string

medicalSpecialty

string

personnelType

object

int64

name

string

description

string

staffType

string

CLINICAL NON_CLINICAL

reserved

boolean

accessTags

array of strings

accessTags

photoUrl

string

smallAvatarUrl

string

bigAvatarUrl

string

jobs

array of objects

jobs

object

int64

status

string

ACTIVE INVITED IMPORTED DECLINED DENIED DELETED ARCHIVED

archivedDateTime

date-time

startDate

date-time

trialEndDate

date-time

endDate

date-time

signedOff

boolean

skipOnboarding

boolean

workSiteId

int64

role

object

employeeComplianceStatus

string

COMPLIANT NOT_COMPLIANT

complianceStatusTags

array of objects

complianceStatusTags

object

key

string

group

string

COMPLIANCE_ERROR COMPLIANCE_OK

documents

array of objects

documents

object

string

description

string

type

object

otherTypeName

string

employeeId

string

versions

int64

activeFile

object

statusType

string

NO_REQUIRED_DOCUMENT DOCUMENT_EXPIRED PENDING_APPROVAL DOCUMENT_DECLINED EXPIRING_SOON READY_TO_PRACTICE

files

array of objects

deprecated

files

object

int64

issued

date

expiry

date

monthToExpire

int64

daysToExpire

int64

created

date-time

verifications

array of objects

verifications

object

verificationType

string

required

CONTENT_VERIFIED APPROVED DECLINED PRIMARY_SOURCE_API PRIMARY_SOURCE_MANUAL NAME_MATCH CQC_CHECK

note

string

created

date-time

verifier

object

issuingAuthority

string

deprecated

issuingPerson

string

deprecated

uploader

object

documentNumber

string

deprecated

fileType

string

deprecated

UNKNOWN PDF WORD WORD_DOC WORD_NON_CONVERTED IMAGE TIFF_NON_CONVERTED EXCEL XLS XLSX PPT PPTX UNKNOWN_NON_CONVERTED

checksum

string

deprecated

originName

string

deprecated

documents

array of objects

deprecated

documents

object

string

createdBy

string

deprecated

comments

array of objects

deprecated

comments

object

string

message

string

owner

object

created

date-time

fields

array of objects

deprecated

fields

object

name

string

status

string

PROCESSING PROCESSED PROCESSING_CANCELED

employeeComplianceStatus

string

COMPLIANT NOT_COMPLIANT

complianceStatusTags

array of objects

complianceStatusTags

object

key

string

group

string

COMPLIANCE_ERROR COMPLIANCE_OK

checklists

array of objects

checklists

object

int64

type

string

ONBOARDING OFFBOARDING

status

string

COMPLETED IN_PROGRESS DECLINED NOT_APPLICABLE NOT_STARTED

startedDateTime

date-time

completedDateTime

date-time

checklistId

int64

name

string

organisationId

int64

steps

array of objects

steps

object

int64

completed

boolean

completedDateTime

date-time

stepId

int64

name

string

description

string

type

string

WELCOME INFORMATION UPLOAD_DOCUMENTS READ_EMPLOYMENT_DOCUMENT SIGN_EMPLOYMENT_DOCUMENT EMPLOYEE_APPROVAL VIDEO_TRAINING QUESTIONNAIRE REFERENCE_CHECK DBS_CHECK LAUNCH_WEBPAGE UPLOAD_SPECIFIC_DOCUMENTS RIGHT_TO_WORK PROFESSIONAL_REGISTRATION_CHECK READ_AND_DOWNLOAD_DOCUMENTS_STEP UPLOAD_MANDATORY_DOCUMENTS PROFESSIONAL_TESTS CUSTOM_PROFILE HSH_INTEGRATION DIGITAL_IDENTITY

canBeSkipped

boolean

mandatory

boolean

additionalInformation

object

approval

object

completedBy

object

signedDocuments

array of objects

deprecated

signedDocuments

object

employerDocumentId

string

organisationId

int64

name

string

accessType

string

tags

array of strings

tags

registrationNumber

string

registrationNumberType

string

GMC HCPC NMC GPHC GOC GDC GOSC PSNI GCC SWE UNKNOWN

registrationNumberStatus

string

NEW CHECKED IN_PROGRESS

hcpcInfo

object

registrationNumber

string

registrationNumberType

string

GMC HCPC NMC GPHC GOC GDC GOSC PSNI GCC SWE UNKNOWN

fullName

string

surname

string

givenName

string

speciality

string

profCode

string

town

string

status

string

registeredFrom

date

registeredTo

date

localAnaesthetic

string

prescriptionOnlyMedicine

string

supplementaryPrescribing

string

independentPrescribing

string

modalities

string

lastCheckDateTime

date-time

integration

string

DBS GMC PERFORMERS_LIST HCPC NMC UK_GPHC USA_NURSYS USA_CHECKR USA_UNA USA_SAM USA_OIG RTW YOTI HSH

nmcData

object

registrationNumber

string

registrationNumberType

string

GMC HCPC NMC GPHC GOC GDC GOSC PSNI GCC SWE UNKNOWN

fullName

string

int64

birthDate

date

status

string

lastCheckDateTime

date-time

qualifications

array of objects

qualifications

object

abbreviation

string

startDate

date

feeExpiryDate

date

renewalDate

date

comment

string

integration

string

DBS GMC PERFORMERS_LIST HCPC NMC UK_GPHC USA_NURSYS USA_CHECKR USA_UNA USA_SAM USA_OIG RTW YOTI HSH

gmcInfo

object

registrationNumber

string

registrationNumberType

string

GMC HCPC NMC GPHC GOC GDC GOSC PSNI GCC SWE UNKNOWN

fullName

string

surname

string

givenName

string

gender

string

MALE FEMALE

qualification

string

yearOfQualification

string

placeOfQualification

string

provisionalRegistrationDate

date

fullRegistrationDate

date

specialistRegisterDate

date

gpRegisterDate

date

registrationStatus

string

arfDueDate

date

specialty1

string

subSpecialty1

string

specialty2

string

subSpecialty2

string

specialty3

string

subSpecialty3

string

specialty4

string

subSpecialty4

string

specialty5

string

subSpecialty5

string

specialty6

string

subSpecialty6

string

specialty7

string

subSpecialty7

string

ftpConditionsExist

boolean

ftpUndertakingsExist

boolean

otherNames

string

ftpWarningsExist

boolean

placeOfQualificationCountry

string

revalidationStatus

string

designatedBody

string

responsibleOfficer

string

doctorInTraining

boolean

trainingDeaneryLetb

string

trainingProgrammeSpecialty

string

gmcApprovedTrainer

boolean

trainerDeaneryLetb1

string

trainerProgrammesSpecialty1

string

trainerDeaneryLetb2

string

trainerProgrammesSpecialty2

string

trainerDeaneryLetb3

string

trainerProgrammesSpecialty3

string

idCheckNotDone

boolean

temporaryCovidRegistration

boolean

lastCheckDateTime

date-time

integration

string

DBS GMC PERFORMERS_LIST HCPC NMC UK_GPHC USA_NURSYS USA_CHECKR USA_UNA USA_SAM USA_OIG RTW YOTI HSH

questionnaires

array of objects

questionnaires

object

string

questionnaireFormPublicId

string

questionnaireFormAnswersGroupId

int64

questionnaireId

int64

title

string

answers

array of objects

answers

object

int64

questionId

string

question

string

answer

string

formSchema

object

version

int32

processingFiles

array of objects

deprecated

processingFiles

object

int64

issued

date

expiry

date

monthToExpire

int64

daysToExpire

int64

issuingAuthority

string

length between 0 and 100

issuingPerson

string

length between 0 and 256

documentNumber

string

length between 0 and 30

fileType

string

UNKNOWN PDF WORD WORD_DOC WORD_NON_CONVERTED IMAGE TIFF_NON_CONVERTED EXCEL XLS XLSX PPT PPTX UNKNOWN_NON_CONVERTED

checksum

string

originName

string

documents

array of objects

documents

object

string

uploader

object

createdBy

string

created

date-time

verifications

array of objects

verifications

object

verificationType

string

required

CONTENT_VERIFIED APPROVED DECLINED PRIMARY_SOURCE_API PRIMARY_SOURCE_MANUAL NAME_MATCH CQC_CHECK

note

string

created

date-time

verifier

object

comments

array of objects

deprecated

comments

object

string

message

string

owner

object

created

date-time

fields

array of objects

fields

object

name

string

status

string

PROCESSING PROCESSED PROCESSING_CANCELED

fileId

int64

deprecated

groups

array of objects

groups

object

string

name

string

tags

array of objects

tags

object

int64

name

string

organisationGroupMembers

array of objects

organisationGroupMembers

object

organisationGroupPublicId

string

jobPositionId

int64

actingOtherOrganisation

boolean

grade

string

401

Unauthorized

403

Forbidden

404

Not found

Language

Credentials


xxxxxxxxxx
1
curl --request POST \
2
     --url https://app.credentially.io/mp/api/organisations/organisationId/employees/invite \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK